https://github.com/liammartens/jawnt-task

https://github.com/liammartens/jawnt-task

Last synced: 11 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/liammartens/jawnt-task
• Owner: LiamMartens
• Created: 2024-01-30T21:46:04.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-01-31T15:17:13.000Z (11 months ago)
• Last Synced: 2024-10-18T16:14:11.752Z (2 months ago)
• Language: TypeScript
• Size: 183 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Project set-up

### Package manager & runtime

The project has been set-up with [Bun](https://bun.sh/) as it's package manager and runtime. This makes it simpler to run TypeScript files since no additional build is required.

### Structure

The codebase is structured as a monorepository with the following parts:

- `api-contract`  

  This is the API contract schema created to be shared between app and server.

- `backend`  

  This is the server application.

- `frontend`  

  This is the front-end web application.

### Quickstart

1. Start the local Postgres database using the make job: `make start-local-db`

2. Install the dependencies using bun (`bun install`)

3. Build the shared `api-contract` package (`bun turbo run compile'`)

4. Running the server

  1. Navigate to the `./backend` directory

  2. Copy the `.env.example` file to `.env.`

  3. Run the development migrations using the following command (`bun prisma migrate dev`)

  4. Run the development seed (`bun prisma db seed`)

  5. Run the server app itself using the command: `bun run start`

5. Running the front-end

  1. Navigate to the `./frontend` directory

  2. Run the app using the command `bun run dev`