Introduction

This section provides an overview of the product.

Hey entrepreneur, welcome to BuddyBrain!
Here's a quick overview of the boilerplate. Follow along to get your app up and running.

Getting Started

The repository you got access has a folder called /apps, inside this folder you'll find two other folders:

/frontend: Here's where you'll find the NextJS project for you frontend, this frontend project is where you'll sign up to create your account, input the company's info and connect your Google account. After sign in you'll have a dashboard where you can start the WhstaApp session and see the appointments, it's never enough to remind you that everything can be now customized by you to meet your desires.
/backend: Here's where most of the logic happens, it's the NodeJS API where we have all the logic related to several things such as database, auth, A.I. training, emails, appointments and etc.

Quick Start

Clone the Repository

In your terminal, run the following commands one-by-one:

git clone git@github.com:rafaelpadovani/buddybrain.git [YOUR_APP_NAME]
# or if you don't SSH set up use HTTPS
git clone https://github.com/rafaelpadovani/buddybrain.git [YOUR_APP_NAME]
cd [YOUR_APP_NAME]/apps
git remote remove origin
cd backend && yarn
cd ..
cd frontend && yarn

Note:

Keep in mind that if you choose to clone using HTTPS when Git prompts you for your password please enter your personal access token. More details here in the official docs.

Note:

BuddyBrain requires Node 18 or greater. Type node -v in your terminal to check version. This project has been developed and tested using node v19.2.0 and npm 8.19.3, so we highly recommend you to use those.

Now both project have all the necessary dependecies installed!

Environment files

The environment you most need to care about is inside /backend.
Rename .env.example to .env.

mv .env.example .env

Here we have many keys, don't worry we're gonna go though each of them!

Before installing our application, make sure you have the following:

Remember:

Node.js installed lets you run JavaScript outside the browser and manage dependencies with npm, essential for frameworks like React and Next.js.

Conclusion

Thank you for choosing the BuddyBrain! Now you have the project ready to be cinfigured. In the next session we'll start setting up the environment keys, it's the last step for you to have a project ready to go!

Installation