https://github.com/diegorezm/event-app-api
https://github.com/diegorezm/event-app-api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/diegorezm/event-app-api
- Owner: diegorezm
- Created: 2024-08-19T20:39:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-30T19:20:17.000Z (about 1 year ago)
- Last Synced: 2025-04-09T07:53:35.201Z (9 months ago)
- Language: TypeScript
- Size: 397 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Event app api
## Development
### Folder structure
- `src/`: source code
- `src/db/`: database connection setup and schema
- `src/models/`: database models
- `src/repositories/`: database operations
- `src/services/`: gets data from the database via repository and sends to the controller
- `src/routes/`: where the routes are defined
- `src/utils/`: utilities that are used in different parts of the project
- `src/di`: Dependency injection
### Setup
- install dependencies
```
npm install
```
- setup env variables
```
cp .env.example .env
```
- run docker
```
docker compose -f docker-compose.dev.yaml up -d
```
- generate migrations
```
npm run db:generate
```
- run migrations
```
npm run db:migrate
```
- run tests
```
npm run test
```
- run the project
```
npm run dev
```