https://github.com/wesscoby/picnic-planner-api
https://github.com/wesscoby/picnic-planner-api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/wesscoby/picnic-planner-api
- Owner: wesscoby
- Created: 2022-10-27T06:29:55.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-27T06:30:05.000Z (over 2 years ago)
- Last Synced: 2025-02-01T16:22:00.866Z (4 months ago)
- Language: CSS
- Size: 121 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Picnic Planner API
An application which helps in choosing a date and location, based on optimal weather conditions, for hosting picnics.
Project was bootstrapped with [Nest](https://github.com/nestjs/nest) - a progressive Node.js framework for building efficient and scalable server-side applications.
## Installation
```bash
$ yarn
```
## Setup
- Create `.env` and `.env.test` environment variable files in the root of the project
- Copy over the environment variables from the `*.example` environment files into their respective `.env*` files
- Head over to [OpenCage](https://opencagedata.com/), sign up for a free account and obtain an API key
- Add the API key as value for `GEOCODER_API_KEY` variable in both `.env` and `.env.test` files.
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run dev
# production mode
$ npm run start:prod
```
While the application is running, open your browser and navigate to http://localhost:5000/docs. You should see the Swagger UI.
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage (unit)
$ npm run test:cov
# test coverage (e2e)
$ npm run test:e2e:cov
```