https://github.com/okerx/electrify-api
https://github.com/okerx/electrify-api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/okerx/electrify-api
- Owner: okerx
- Created: 2022-07-13T10:38:59.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-19T15:29:56.000Z (almost 3 years ago)
- Last Synced: 2024-08-11T05:08:55.935Z (10 months ago)
- Language: TypeScript
- Size: 115 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Electrify API
An API server for Electrify application. This project was built with Nest.js framework with basic configuration.
To get started, you can check out the commands below. You can also learn more about Nest.js on their [official documentation website](https://docs.nestjs.com/).
## Live demo
This App is deployed as a Docker container on Heroku.
You can check out the API Swagger docs here https://electrify-chargers.herokuapp.com/docs
## Installation
```bash
$ yarn
```
## Connecting to the database
This project requires a MongoDB instance. Before running the app you must define the environment variables
- `MONGO_URL` Full MongoDB URL with credentials.
- `DB_NAME` The name of your database.
> ⚠️️ **This project doesn't support `.env` files**
you need to manually define the env variables in your terminal
```bash
export MONGO_URL=mongodb+srv://... && DB_NAME=electrify
```
## Running the app
```bash
# development
$ yarn start
# watch mode
$ yarn start:dev
# production mode
$ yarn start:prod
```
## Test
```bash
# unit tests
$ yarn test
# e2e tests
$ yarn test:e2e
# test coverage
$ yarn test:cov
```