https://github.com/mkloz/swapi
Nestjs backend(starwars api)
https://github.com/mkloz/swapi
api backend nestjs rest typescript
Last synced: about 2 months ago
JSON representation
Nestjs backend(starwars api)
- Host: GitHub
- URL: https://github.com/mkloz/swapi
- Owner: mkloz
- Created: 2023-04-24T16:49:23.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-24T16:54:44.000Z (about 3 years ago)
- Last Synced: 2025-03-20T22:18:55.391Z (over 1 year ago)
- Topics: api, backend, nestjs, rest, typescript
- Language: TypeScript
- Homepage:
- Size: 142 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Starwars API like Swapi on NestJS
## Description
API where saved all information about starwars.
## Installation
```bash
$ npm install
```
## Running the app
Set all environment variable(.env file in the root of project) and constants. Then run the application
```bash
# Building
$ npm run build
# Up migrations
$ npm run migration:run
# Seeding
$ npm run seed:run
# After that you can start
$ npm run start
```
Start with docker compose
Set all variables in .env file(instead DB_HOST=localhost you should use DB_HOST=mysql)
```bash
# Building images
$ docker-compose build
# Start app
$ docker-compose up
```
If you want to check out a state of program -> /api/health (only for admins)
## Documentation
Swagger is used here. Api documentation is located on route `/api/docs`