RESTful API for zombie apocalypse system running with Nest framework TypeScript.
You can find all the API documentation here
- Install postgreSQL here
- Install postGIS by follow this tutorial here
- Install pgAdmin4 here
- Install nodejs here
- Open the .env file and replace DB_PASSWORD with your own postgreSQL password
- npm i -g @nestjs/cli
- npm install --force
- npm run start
- Survivor (survivor.controller.ts @ survivor.service.ts @ survivor.module.ts)
- Register survivor
@Post('survivor/create')
- Get survivor
@Get('survivor')
- Update survivor location
@Patch('survivor/update')
- Generate survivor report
@Get('survivor/report')
- Register survivor
- Inventory (inventory.controller.ts @ inventory.service.ts @ inventory.module.ts)
- get inventory
@Get('inventory')
- get inventory
- Controllers are responsible for handling incoming requests and returning responses to the client.
- For example, app.controller.ts
- The service will be responsible for data storage and retrieval, and is designed to be used by the Controller
- For example, app.service.ts
- A module is a class annotated with a @Module() decorator. The @Module() decorator provides metadata that Nest makes use of to organize the application structure.
- For example, app.module.ts