https://github.com/diegokarabin/files-api
https://github.com/diegokarabin/files-api
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/diegokarabin/files-api
- Owner: DiegoKarabin
- Created: 2025-03-26T21:22:11.000Z (7 months ago)
- Default Branch: develop
- Last Pushed: 2025-03-26T21:38:44.000Z (7 months ago)
- Last Synced: 2025-03-26T22:28:13.130Z (7 months ago)
- Language: TypeScript
- Size: 136 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
Files API V1
## Instructions to run the project
### 1. Create .env file
Copy the .env.example and fill the required variables
```bash
cp .env.example .env
```
### 2. Build docker container
```bash
docker compose up --build
```
### 3. Use SWAGGER Documentation to test the API
The swagger documentation is served at:
```
http://localhost:3000/api
```
## Run tests
```bash
# unit tests
$ npm run test
# e2e tests
$ npm run test:e2e
# test coverage
$ npm run test:cov
```