Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/de3ph/bookstore-api
Bookstore API
https://github.com/de3ph/bookstore-api
api-testing authentication bcrypt docker eslint mongodb mongoose nestjs passport-jwt passport-local passportjs prettier swagger testing typescript unit-test
Last synced: about 1 month ago
JSON representation
Bookstore API
- Host: GitHub
- URL: https://github.com/de3ph/bookstore-api
- Owner: De3ph
- Created: 2023-08-23T10:57:41.000Z (about 1 year ago)
- Default Branch: vercel
- Last Pushed: 2023-11-28T18:42:37.000Z (12 months ago)
- Last Synced: 2024-01-27T19:07:20.755Z (10 months ago)
- Topics: api-testing, authentication, bcrypt, docker, eslint, mongodb, mongoose, nestjs, passport-jwt, passport-local, passportjs, prettier, swagger, testing, typescript, unit-test
- Language: TypeScript
- Homepage: https://bookstore-api-production-364f.up.railway.app/
- Size: 426 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest
A progressive Node.js framework for building efficient and scalable server-side applications.
## Description
[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
## Installation
```bash
$ npm install
```
## .env
Create .env file in the root directory of the project. .env file should include these properties:
```
MONGO_CONNECTION_STRING=XXX
MONGO_DATABASE_NAME=XXX
```
## Running the app
```bash
# development
$ npm run start
# watch mode
$ npm run start:dev
# production mode
$ npm run start:prod
```
## Docker
In order to use Docker container, you should provide same .env properties.
```bash
# create .env file and define variables.
$ touch .env.docker
# run
$ docker-compose up
```
## Test
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```
## API Documentation
Swagger API documentation is available on `http://localhost:3000/api` route.
## ToDo
- [ ] More Detailed Swagger Documentation
- [ ] Unit Test
- [ ] Integration Test
- [ ] E2E Test
- [x] Dockerize
- [ ] Front-end??
## Support
Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
## License
Nest is [MIT licensed](LICENSE).