Skip to content

Appa is a real-time package delivery system built with Socket.io

Notifications You must be signed in to change notification settings

kwadwoatta/appa-api

Repository files navigation

Appa Backend API

Appa Logo

Installation

  1. clone the repo

    git clone https://github.com/kwadwoatta/appa-api.git
  2. cd into the repo

    cd appa-api
  3. copy .env.example to .env and fill them out

  4. install all dependencies

    pnpm install
  5. download docker

  6. start the mongodb (database) service

    docker compose up -d
  7. start the app in development mode

    pnpm start:dev
  8. import db/appa.user.json into mongodb

  9. visit url in Postman

    http://localhost:3000/api/
  10. login with one of the seeded users

    {
        "email": "[email protected]",
        "password": "password"
    }
  11. copy access token and set as authorization header for subsequent requests

    Authorization: Bearer {your access token}

About

Appa is a real-time package delivery system built with Socket.io

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published