Quick Start Guide

Let's get you project up and running.

Now that we have everything in place let's get the servers uo and running.

Open the terminal and navigate to the /backend folder inside the repo and run:

yarn dev

This will start the backend server that will run on port 8383.

Now open another terminal or just another terminal tab, navigate to the /frontend folder and run:

yarn dev

This will start the frontend server with NextJS that will run on port 3000.

Now you if you navigate to http://localhost:3000/ you should see something like this:

BuddyBrain Hero

Now you are to start playing with it! By hitting Start button you can sign up to create your user with all the information needed.

Here's a walkthrough for the sign up process:

Once you're in the Dashboard go to the Connection and hit the button Start Assistant. This will generate the QRCode to connect your WhatsApp to the server.

After starting session you should get the QRCode to connect your WhatsApp with the application: BuddyBrain WhatsApp QRCode

That should be enough to be able to chat with the assistant but in order to lavarage the booking feature remember to link you Google account: BuddyBrain dashboard google link

And now you are ready rock! BuddyBrain ready

On your terminal where you're running the backend every time the server restart you should see something like this, it means that once you connect your WhatsApp device for the first time, every time the server restarts the backend will try to restore that session to make sure your assistant is always up and running! BuddyBrain Terminal

On the dashboard you also have thre other sections: Home, Account and Appointments.

Home

Here you have all current appointments yet to come and active clients.

Account

Here you can edit the account information you provided during sign up process. BuddyBrain account tab

Appointments

Here you have listed both current and past appointments, each row has a direct link to the appointment in the calendar. BuddyBrain Appointments tab

If you have any doubts on how to link your device please refer to WhatsApp official docs to get the exact steps. It's really simple!

Conclusion

Now you should be ready to get full usage of BuddyBrain features and total freedom to improve it or change it to meet your specific needs!