https://github.com/blankparticle/postal-api

https://github.com/blankparticle/postal-api

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/blankparticle/postal-api
• Owner: BlankParticle
• Created: 2024-03-14T17:59:35.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-14T18:04:39.000Z (9 months ago)
• Last Synced: 2024-11-04T22:42:17.818Z (about 2 months ago)
• Language: TypeScript
• Size: 23.4 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## How to get Started

1. Clone the repository

2. Install [Bun](https://bun.sh)

3. Run `bun install` to install the dependencies

4. Copy the `.env.example` file to `.env` and fill in the required environment variables

5. Run `bun start` to start the development server

## API Endpoints

After starting the development server, the API docs will be available at `http://localhost:3000/swagger`