This is a backend api service for SCNG APP.
You can find frontend mobile app here.
Live version of the app is deployed to heroku and is available here. You may have to wait for the app to start, bacause heroku puts the app to sleep after 30min of inactivity.
- Clone repo locally
git clone https://github.com/bartolomej/scng-api.git - Install external node modules
npm i - Configure environmental variables
- Run all tests with
jest test - Run application with
npm start
Instead of hard-coding config into some file that is committed to git, it is a good practise to provide app configuration values is via "environmental variables".
That way you achieve a healthy separation of configuration (the inputs that the app receives) and the application itself. Read more about "good practises" here.
An example configuration file can be found under ./env.examples.
- Create a new dummy google account
- Disable 2FA auth so that app can login autonomously without your confirmation
- Allow access for less secure apps here
- Provide google account credentials to environmental variables
The easiest way to deploy this app is using Heroku platform:
- click deploy to heroku button (located at the top of readme)
- set environment variables under
settings -> config vars
- TypeORM - Object Relational Mapper for Node.js
- Nodemailer - simple email module for Node.js
- Cheerio - HTML parsing
- Winston - universal logging library
- Heroku - cloud deployment platform
- Handlebars - templating engine