noahschutte/counselar

Online training platform

CounselAR

Online training platform

TODO: https://www.counselar.com

Product information

• Wireframe: https://projects.invisionapp.com/freehand/document/oliZGY1nr
• Drawio ERD: https://drive.google.com/file/d/19rwwYUjVhEdWp6CGKPl_83fPujucM-G3/view?usp=sharing
• Postman API Documentation: https://documenter.getpostman.com/view/582732/T1Dv9aLw?version=latest

Tech Stack and Services

• node.js, express, mongoDB, mongoose
• MongoDB hosted on MongoDB Atlas
• CI/CD automatic deploy with GitHub/Heroku pipeline
• TODO: DNS and SSL handled by AWS Route 53
• TODO: Asset storage handled by AWS S3
• TODO: Email development handled by Mailtrap
• TODO: Email client handled by SendGrid
• TODO: Payment handled by Stripe

Run Application Locally

1. Local dependencies:
   • node version ^14
   • npm version ^6
   • ndb version ^1
   • mongodb
2. cp example_config.env config.env
3. Obtain environment variables for config.env
4. npm start

Local Development Tools

• npm run dev uses nodemon
• npm run debug uses node debugger
• CAUTION: npm run start:prod connects to production services
• postman
• compass
• VSCode

Deploy to Production Environment

https://counselar.herokuapp.com/

1. Merge to master branch will automatically deploy to production environment