Brainiac-Brigade Procrastination App

Crammar Education have tasked the Brainiac-Brigade with creating an app to add to their education portfolio to support students with revision.

API | CLIENT

Installation

If you want to run the app in your local machine:

Clone the repo

git clone git@github.com:JackDMoore/Brainiac-Brigade.git

# cd inside the repo folder
cd Brainiac-Brigade

Server

To install the server packages

# from the repo root 
# cd inside the api folder
cd api

# install packages
npm install

Create a .env file in the api root folder

touch .env

# You need to add the following enviroment variables to the .env file:

  # MongoDB URI (please create and add your own MongoDB URI)
  MONGODB_URI: mongodb+srv://username:password@host:port/database?options...

  # PORT
  PORT = 3000

  # SECRET for JasonWebToken
  SECRET = "your secret"

Client

To install the server packages

# from the repo root 
# cd inside the client folder
cd client

# install packages
npm install

How to start

Start api server

# from the api folder
npm run dev

You should see something like this in your terminal:

Start client server

# from the client folder
npm run dev

You should see something like this in your terminal:

Technologies used

• HTML
• CSS
• React
• React calendar library
• JS
• Node
• Vite
• MongoDB

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.