https://github.com/oliveirad4vi/click-project-back
This is a repository for the API of the Click Project.
https://github.com/oliveirad4vi/click-project-back
nodejs postgresql
Last synced: 2 months ago
JSON representation
This is a repository for the API of the Click Project.
- Host: GitHub
- URL: https://github.com/oliveirad4vi/click-project-back
- Owner: oliveiraD4vi
- License: mit
- Created: 2022-06-21T00:20:06.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-08-24T20:52:48.000Z (almost 4 years ago)
- Last Synced: 2025-01-08T03:06:51.188Z (over 1 year ago)
- Topics: nodejs, postgresql
- Language: JavaScript
- Homepage:
- Size: 4.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Click Project API
Click is a project developed and improved during the Software Engineering course at UFC - Quixadá campus. The system proposes a vote for films to be shown in a school cinema or social project. The purpose of the project is to exercise project development and organization skills.
## Starting
After clonning the repository, run
```
npm i
```
in order to install the right dependencies needed. Then run
```
node server.js
```
to see the server running locally.
This application is under development, see the [FrontEnd repository](https://github.com/oliveiraD4vi/click-project). You can see the aplication running on [Click](https://click-project.vercel.app/).
It also uses a connection with a Postgres DB, so you will need it. See the .env-example file, and create a .env with those variables. If you want to change the used DB, see [Sequelize](https://sequelize.org/docs/v6/getting-started/).
## Build with
* [NodeJs](https://pt-br.reactjs.org/) - The runtime environment used
* [Postgres](https://www.postgresql.org/) - The DB used
* [JWT](jwt.io) - The method for representing claims securely between two parties
* [Sequelize](https://sequelize.org/) - The DB ORM used
## Version
See the [tags in this repository](https://github.com/oliveiraD4vi/click-project-back/tags).
## License
[MIT](https://choosealicense.com/licenses/mit/)