Project Architecture

Backend: BrightIdeasAPI - Includes API endpoints and chat server hosted on Heroku

Frontend: BrightIdeas - UI of the app hosted on VM

Database: MySQL hosted on VM

Working on the Project

Clone the repo to your local machine

git clone https://github.com/LupodeLupis/BrightIdeas.git

Change directories

cd bright-ideas

Install Angular CLI

npm install -g @angular/cli

Install dependencies

npm install

If npm fails to install bcrypt

sudo apt-get install -y build-essential python

Build project

npm run build

run front-end using angular host

ng serve

Run front-end using node (only on vm)

node server.js

Developer Guide

Must Read for developers

Creating Features

Make sure to branch off of develop

git checkout develop

Pull latest code from the develop branch into your local develop branch

git pull develop

Name your features like below. Replace only "yourfeature" with whatever you want to call it.

git checkout -b feature-yourfeature

Push the branch from your local to the repo so everyone can see it

git push origin feature-yourfeature

Updating the VM

How to update the vm