Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ruslanguns/nest-request-server
https://github.com/ruslanguns/nest-request-server
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/ruslanguns/nest-request-server
- Owner: ruslanguns
- Created: 2021-05-16T13:44:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-15T05:14:11.000Z (11 months ago)
- Last Synced: 2024-05-28T17:07:37.598Z (6 months ago)
- Language: TypeScript
- Size: 255 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Nest Request Job Cards Server!
## Description
This server is made using [Nest](https://github.com/nestjs/nest) framework with TypeScript language.
## Available API endpoints
| No. | Method | Description | Endpoint |
|----- |-------- |---------------------------------|------------------------ |
| 1 | GET | Get a user randomly | /user/random |
| 2 | PUT | Get User By id | /user/:userId |
| 3 | PUT | Update/Create user address | /user/address |
| 4 | PUT | Update/Create user photo | /user/photo/:userId |
| 5 | GET | Get list of requested job cards | /request/job-card |
| 6 | POST | Request a Job Card | /request/job-card |
| 7 | POST | Upload a file into AWS | /file/upload |
| 8 | GET | Download a file from AWS | /file/download/:fileName |
## Installation
```bash
$ yarn install
```
## Start database
Rename the `.env.sample` file into `.env` and fill it with your database and AWS S3 bucket credentials.
```bash
$ yarn prisma:apply
```
## Seed database (if necessary)
```bash
$ yarn prisma:seed
```
## Running the app
```bash
# development
$ yarn start
# watch mode
$ yarn start:dev
# production mode
$ yarn start:prod
```
## Test
```bash
# unit tests
$ yarn test
# e2e tests
$ yarn test:e2e
# test coverage
$ yarn test:cov
```
> Read the `package.json` for more scripts.
## Stay in touch
- Author - [Ruslan Gonzalez](https://rusgunx.tk)
- Website - [https://rusgunx.tk](https://rusgunx.tk/)
- Twitter - [@ruslangonzalez](https://twitter.com/ruslangonzalez)