https://github.com/qlaffont/starter-api

Starter project for API
https://github.com/qlaffont/starter-api

fastify

Last synced: 2 months ago
JSON representation

Starter project for API

• Host: GitHub
• URL: https://github.com/qlaffont/starter-api
• Owner: qlaffont
• Created: 2022-10-18T07:03:36.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-04-13T23:43:00.000Z (10 months ago)
• Last Synced: 2024-04-14T00:58:52.699Z (10 months ago)
• Topics: fastify
• Language: TypeScript
• Homepage:
• Size: 2.64 MB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# STARTER API

Used by :

- [Flexper](https://github.com/flexper)

## Server requirements

- Node (Please check .nvmrc to get Node.JS version)

- Postgres database ( or Docker for development )

## How to start the project ?

### Local

- Fill environment variables to `.env` file based on `.env.example`

- Start server `pnpm dev`

### Deployed environments

- Fill environment variables to `.env` file based on `.env.example`

- Build app `pnpm build`

- Start server  `pnpm start`

## Package Scripts

- `dev` : Start Dev server (hot reload activated)

- `dev:worker` : Start Dev worker (hot reload activated)

- `build` : Build app + worker

- `start` : Start server in production mode

- `start:worker` : Start worker in production mode

- `lint` : Lint all files

- `generate` : generate prisma client

- `migration:up` : deploy migrations

- `migration:make` : generate migration

- `migration:reset` : reset migrations + data

- `prepare` : Install husky

- `update-template` : Update project with template (/!\ Verify result !)