mirror of
https://github.com/franjsco/tick3t-api
synced 2024-12-21 20:44:19 +01:00
edit readme
This commit is contained in:
parent
591601a132
commit
a09ec20871
36
README.md
36
README.md
@ -1,2 +1,36 @@
|
||||
# tick3t-api
|
||||
tick3t-api
|
||||
|
||||
A REST API for tick3t.
|
||||
|
||||
**Technologies**:
|
||||
|
||||
- Node.js
|
||||
- express
|
||||
- mongodb
|
||||
|
||||
## Installation
|
||||
|
||||
1. Install `Node.js` and `npm`.
|
||||
2. Install `mongodb`.
|
||||
3. Clone this repository.
|
||||
4. Install dependencies with `npm install`
|
||||
5. Create env file or set environment variables. (read "Environment variables" paragraph)
|
||||
6. Build with `npm run build`.
|
||||
7. Start the server with `npm run serve`.
|
||||
|
||||
### Environment variables
|
||||
|
||||
Configure the environment variables:
|
||||
|
||||
```text
|
||||
NODE_ENV=production
|
||||
PORT=server-port
|
||||
SECRET_KEY=your-secret-key
|
||||
DB_URL=mongodb://your-host:port/db
|
||||
DB_USER=your-user
|
||||
DB_PASSWORD=your-password
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
GPLv3
|
||||
|
Loading…
Reference in New Issue
Block a user