Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hugos68/routerunner-api
A logistic app for truckdrivers for keeping track of their trips and registering orders and retour packagings.
https://github.com/hugos68/routerunner-api
api bun drizzle hono
Last synced: about 1 month ago
JSON representation
A logistic app for truckdrivers for keeping track of their trips and registering orders and retour packagings.
- Host: GitHub
- URL: https://github.com/hugos68/routerunner-api
- Owner: Hugos68
- License: mit
- Created: 2024-09-23T11:31:32.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-10-18T12:17:36.000Z (3 months ago)
- Last Synced: 2024-12-07T10:04:57.875Z (about 1 month ago)
- Topics: api, bun, drizzle, hono
- Language: TypeScript
- Homepage: https://routerunner.nl
- Size: 303 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Routerunner
A logistic app for truckdrivers for keeping track of their trips and registering orders and retour packagings.
## Local Development
### Prerequisites
Before you begin, ensure you have the following installed:
- [Bun](https://bun.sh/)
- [PostgreSQL](https://www.postgresql.org/)
### Installation
1. Clone the repository:
```
git clone https://github.com/Hugos68/routerunner.git
cd routerunner
```
2. Install dependencies:
```
bun install
```
3. Set up environment variables:
- Copy the `.env.example` file to `.env`
- Fill in the necessary environment variables in the `.env` file
### Development
To start the development server:
```
bun run dev
```
The server will start on `http://localhost:3000`.
The base URL for the API is `/api/v1`.
### Database Management
- Push schema changes:
```
bun run drizzle:push
```
- Seed the database:
```
bun run drizzle:seed
```
Note: Once seeded there are 3 registered users with usernames: `driver`, `planner` and `admin`. They all share the same password which is: `1234567890`.
- Open Drizzle Studio:
```
bun run drizzle:studio
```
### Format & Linting
We use Biome for formatting and linting. To check and automatically fix issues:
```
bun run biome:check
```
### Testing
Run tests using Bun's test runner:
```
bun test
```
## Docker
### Prerequisites
Before you begin, ensure you have the following installed:
- [Docker](https://www.docker.com/)
### Docker Compose
To build and run the app (including a PostgresSQL database):
```
docker-compose up -d --build
```
## API Documentation
- Swagger UI: Available at `/api-docs`
- OpenAPI documentation: Available at `/api-spec`
## License
See [LICENSE](./LICENSE.txt)