Collaborative project for the BroskiTownUSA group. Both API and APP directories are housed in a single repo for now. There are some project dependencies outlined below. If you have any questions or concerns feel free to reach out. Check out the API and APP README files.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
If you dont already have Node installed, you will need it in order to use this project.
Get Node Here. We recommend the LTS version. If you wanna go crazy, maybe check out NVM.
Then verify installation with:
node --version
We use yarn for this project. In the past it has been touted as being better, and has a slightly better UX in my opinion.
Follow the installation instructions from Yarn.
Then verify installation with:
yarn --version
CD into the API directory
(from project root)
cd broskichat-api
Install
yarn install
Done.
CD into the APP directory
(from project root)
cd broskichat-app
Install
yarn install
Done.
In order to develop on either directory, simply change directory, and run the start script. NOTE The Frontend is dependent on the backend until we have a CI/CD process in place. If you are working on the FE you need to start the BE.
change directory
cd broskichat-api
start it
yarn start
Terminal 1 start the api
cd broskichat-api && yarn start
Terminal 2 change directory
cd broskichat-app
start the app
yarn start
NO CI/CD PROCESS YET
NONE YET
<...>
NONE YET
<...>
- Must be responsive for all screen sizes
- Must match theme
- Pretty
- Make use of bulma classes
No deployment process yet.
- LoopBack - Backend Framework
- React - Frontend Framework
- MongoDB Atlas - DB
- Bulma- CSS Framework
To make a contribution to the project simply open a PR and we will review!
To become a member of the team please contact us by opening an issue in the github repo.
- Taylor Buckner - Initial work - tabuckner
- TEAM MEMBER - ROLE - githubprofile
This project is licensed under the MIT License - see the LICENSE.md file for details