https://github.com/bartolomej/scng-api

Solski Center Nova Gorica API services
https://github.com/bartolomej/scng-api

school-app school-project

Last synced: about 16 hours ago
JSON representation

Solski Center Nova Gorica API services

• Host: GitHub
• URL: https://github.com/bartolomej/scng-api
• Owner: bartolomej
• License: unlicense
• Created: 2019-07-18T21:44:19.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-04T05:30:12.000Z (almost 2 years ago)
• Last Synced: 2023-03-06T23:09:15.813Z (over 1 year ago)
• Topics: school-app, school-project
• Language: CSS
• Homepage: https://bartolomej.github.io/scng-api
• Size: 8.64 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 29
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


    



# SCNG API

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

This is a backend api service for SCNG APP. 


You can find frontend mobile app [here](https://github.com/bartolomej/scng-mobile).


Live version of the app is deployed to heroku and is available [here](https://scng-api.herokuapp.com/). You may have to wait for the app to start, bacause heroku puts the app to sleep after 30min of inactivity.

### ⚙️ Project setup

1. Clone repo locally `git clone https://github.com/bartolomej/scng-api.git`

2. Install external node modules `npm i`

3. Configure environmental variables

4. Run all tests with `jest test`

5. Run application with `npm start`

### ⚒️ App configuration

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](https://12factor.net/config).

An example configuration file can be found under `./env.examples`.

### 📧 How to configure email service

1. Create a new dummy google account

2. [Disable 2FA auth](https://support.google.com/accounts/answer/1064203?co=GENIE.Platform%3DDesktop&hl=en) so that app can login autonomously without your confirmation

3. Allow access for less secure apps [here](https://myaccount.google.com/lesssecureapps)

3. Provide google account credentials to environmental variables

### 🚀 Deploy to Heroku

The easiest way to deploy this app is using Heroku platform:

1. click deploy to heroku button (located at the top of readme)

2. set environment variables under `settings -> config vars`

### 💜 Some tech used

- [TypeORM](https://typeorm.io/) - Object Relational Mapper for Node.js

- [Nodemailer](https://nodemailer.com/about/) - simple email module for Node.js

- [Cheerio](https://cheerio.js.org/) - HTML parsing

- [Winston](https://github.com/winstonjs/winston) - universal logging library

- [Heroku](https://heroku.com/) - cloud deployment platform

- [Handlebars](https://handlebarsjs.com/) - templating engine

### 🔴 Common issues

- [You get `ER_NOT_SUPPORTED_AUTH_MODE` on startup](https://github.com/typeorm/typeorm/issues/2093#issuecomment-574613981)