Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gustavodinizmonteiro/wizard-challenge-backend
https://github.com/gustavodinizmonteiro/wizard-challenge-backend
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/gustavodinizmonteiro/wizard-challenge-backend
- Owner: GustavoDinizMonteiro
- Created: 2020-06-16T01:12:09.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-12-22T16:58:20.000Z (almost 2 years ago)
- Last Synced: 2023-03-05T10:43:06.211Z (over 1 year ago)
- Language: JavaScript
- Size: 336 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Wizard Challenge
===========
Overview
--------
The challenge is to develop a solution that is able to authorization endpoints to user signin/signup.
## Building from source
1. Ensure you have
```Node.js``` installed - goto https://nodejs.org/en/download/package-manager/ to download installer for your OS.
```PostgreSql``` installed or in deployment - goto https://www.postgresql.org/download/ to download installer for your OS.
1. Clone this repository to your local filesystem (default branch is 'master')
1. To download the dependencies
```
npm install
```
1. Create an ```.env``` file and fill it out as indicated in ```.env.sample```
1. To run the application, run the following command on the project root folder
```
npm start
```
## Running npm tasks
### Build
For production you need to provide to enviroment variables:
* `DATABASE`: Database name
* `DB_USER`: Database user name
* `PASSWORD`: Database password
* `HOST`: Host for ProstgreSQL Database
* `KEY`: Key to sign access tokens
With this you need just run the following commands:
* `npm install`
* `npm start` to production server or `npm run dev` - To have a live reload debug server.
and the aplication will start in port 3000.
### Docker
Additionally, you can use docker container to automatise backend deployment using the image available in docker hub
```
docker pull gmonteiro/gmonteiro/wizard-challenge:latest
```
ou building from source following next steps o backend bolder:
```
docker build . && docker-compose build && docker-compose run nodeapp
```
See the online backend demo in https://wizard-challenge-api.herokuapp.com/.
## Getting Started doc
Postman documentation [here](https://documenter.getpostman.com/view/1420305/SzzkccWp?version=latest).
## Contribution guidelines
Not yet