https://github.com/kwadwoatta/appa-api
Appa is a real-time package delivery system built with Socket.io
https://github.com/kwadwoatta/appa-api
mongodb mongoose nestjs socket-io
Last synced: 3 months ago
JSON representation
Appa is a real-time package delivery system built with Socket.io
- Host: GitHub
- URL: https://github.com/kwadwoatta/appa-api
- Owner: kwadwoatta
- Created: 2024-05-25T10:03:46.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-30T19:11:24.000Z (about 2 years ago)
- Last Synced: 2025-03-21T06:11:41.429Z (over 1 year ago)
- Topics: mongodb, mongoose, nestjs, socket-io
- Language: TypeScript
- Homepage:
- Size: 379 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Appa Backend API
## Installation
1. clone the repo
```bash
git clone https://github.com/kwadwoatta/appa-api.git
```
2. cd into the repo
```bash
cd appa-api
```
3. copy .env.example to .env and fill them out
4. install all dependencies
```bash
pnpm install
```
5. [download docker](https://www.docker.com/products/docker-desktop/)
6. start the mongodb (database) service
```bash
docker compose up -d
```
7. start the app in development mode
```bash
pnpm start:dev
```
8. import db/appa.user.json into mongodb
9. visit url in Postman
```bash
http://localhost:3000/api/
```
10. login with one of the seeded users
```ts
{
"email": "customer@gmail.com",
"password": "password"
}
```
11. copy access token and set as authorization header for subsequent requests
```graphql
Authorization: Bearer {your access token}
```