Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ungdev/etu-utt-api
UTT's student website API made with Nest.JS
https://github.com/ungdev/etu-utt-api
Last synced: 15 days ago
JSON representation
UTT's student website API made with Nest.JS
- Host: GitHub
- URL: https://github.com/ungdev/etu-utt-api
- Owner: ungdev
- License: mit
- Created: 2023-04-05T09:40:01.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-30T00:23:48.000Z (22 days ago)
- Last Synced: 2024-10-30T02:50:15.585Z (22 days ago)
- Language: TypeScript
- Size: 2.87 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# EtuUTT API : NestJS & Prisma
## Setup with Docker
Copy environment variables file and fill it with API keys and secrets.
```sh
cp .env.dist .env.dev
cp .env.test.dist .env.test
```
Start the project (add a `-d` flag to run it in background)
```sh
docker compose -f docker-compose.yml -f docker-compose.dev.yml up
```
Everytime that you `up` the project, it will do the following things for you in the background :
- Check and install dependencies (Useful when installing the project for the first time or when switching branches).
- Apply last changes on the `schema.prisma` to the database and update the prisma client.
- Start Prisma Studio [on port 5555](http://localhost:5555).
- Start the NestJS API in dev mode.
Push database changes
```sh
npx prisma db push
```
## Services
You can now go to [http://localhost:3000](http://localhost:3000) to see the app !
| Service name | URL | Description |
| ------------ | --------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| API | [http://localhost:3000](http://localhost:3000) | The API home page. You can address all requests to that endpoint. |
| API | [http://localhost:3000/docs](http://localhost:3000) | The API Swagger documentation. You can read the functional documentation and try all endpoints. |
## How to use
To open a terminal inside the container.
```sh
docker exec -it etu-utt-api sh
```
Inside that terminal, you can run any command you want, like this one to acces NestJS CLI.
```sh
npx nest
```
To run lint.
```sh
npm run lint
```
To run end to end tests (e2e) in watch mode.
```sh
npm run test:e2e
```
## Setup manually
Setup environment variables
```sh
cp .env.example .env
```
Install dependencies
```sh
yarn
```
Setup the database
```sh
yarn prisma generate
yarn prisma db push
```
Start the project
```sh
# In developping mode
yarn start:dev
# In debug mode
yarn start:debug
# In production
yarn build
yarn start:prod
```
## Contribute
To commit
```sh
git cz
```