https://github.com/samuel-ricardo/cloud-humans-backend
https://github.com/samuel-ricardo/cloud-humans-backend
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/samuel-ricardo/cloud-humans-backend
- Owner: Samuel-Ricardo
- License: mit
- Created: 2022-03-10T14:14:25.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-03-18T14:18:47.000Z (about 2 years ago)
- Last Synced: 2025-01-14T12:44:41.360Z (5 months ago)
- Language: TypeScript
- Size: 39.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cloud-Humans-Backend
|
Project |
Technologies |
Routes |
Run |
Author |
#
👨💻 How to use
### Open Your Git Terminal and Clone This Repositore:
```git
$ git clone "https://github.com/Samuel-Ricardo/Cloud-Humans-Backend.git"
```
### Make pull:
```git
$ git pull "https://github.com/Samuel-Ricardo/Cloud-Humans-Backend.gite"
```
You need to have `node.js` in your machine and a package manager (`npm` or `yarn`) to interpret the code and install the dependencies.
```bash
# To install all the dependencies
$ yarn
# To run the project
$ yarn start
# To run tests
$ yarn test
```
You also need to install the React library, click on the image below.
> 
🛠 main technical decisions:
For this project, the stack - Typescript + NodeJS was chosen to build the API and Jest to perform the tests with an organized folder structure and responsibility diluted in the code with the construction, for example, of Controller and Service
relevant comments about your project
🛠 Main Technologies:
- Typescript
- Tests
- Jest
- Mock
- Jest Auto Mock
- @Types
- REST
- Middlewares
- Error Coverage
- Clean Code
#
## :construction: API Routes:
- root - GET - /
- Match Project - POST - /workflow/match-project
#
All routes have error coverage
#
create a global function specialized in calculating the score, a setup that runs before the test every time, middleware to global errors, personalizaed response, routes structure, storage that simulate projects on database, personalized types...
:octocat: Author
