https://github.com/samuel-ricardo/bolao-da-copa_api
https://github.com/samuel-ricardo/bolao-da-copa_api
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/samuel-ricardo/bolao-da-copa_api
- Owner: Samuel-Ricardo
- License: gpl-3.0
- Created: 2022-11-12T17:37:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-18T13:01:45.000Z (over 3 years ago)
- Last Synced: 2025-01-14T12:45:04.131Z (over 1 year ago)
- Language: TypeScript
- Size: 226 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Bolão da Copa - [API]
🚀 🟪 Next Level Week - Copa 2022 🟪 🚀
Application developed during a Full Stack Event, the Next Level Week #10 promoted by @Rocketseat
#
#
|
Project |
Technologies |
Routes |
Run |
Author |
#
| :artificial_satellite: About:
This is an API that uses the NestJS framework, it aims to serve all applications of this project (Web & Mobile). This app uses the Google Auth API to login with a Google account and JWT to keep the authentication for a while and provide a security authentication, making sure you are the right user without having to log in all the time.
For database management we chose Prisma which abstracts all the hard work and lets us focus on the creative and structural part, with a safe migrations scheme (like a .git history but for database changes) it provides a solid system and compatible with many databases. For the server Fastify was used instead of express or other.
#
- Hosted on: Bolão da Copa - [API]
- Repo: [Front-end] - Bolão Da Copa - [Landing Page]
- Repo: [Mobile] - Bolão Da Copa - [APP]
#
- This API is hosted on Render
- Current Version 1.0.0
#
## :construction: API Routes:
Base URL - https://bolao-da-copa-nlw.onrender.com
- Users Routes - /users
- Count - [GET]: /count
#
- Auth Routes - /
- Auth - [GET]: /me
- Register - [POST]: /users
#
- Betting groups Routes - /
- Count - [GET]: /pool/count'
- Get Pools - [POST]: /pools
#
- Games Routes - /pools
- Get games - [GET]: /:id/games'
#
- Guesses Routes - /
- Count - [GET]: /guesses/count'
- Get Guesses - [POST]: /pools/:poolId/games/:gameId/guesses
#
All routes have error coverage, some are accessible only to authenticated users.
#
💻 | Technologies:
> 
- Google APIs
- Google Auth
- JavaScript
- TypeScript
- NodeJS
- NestJS
- Prisma
- Fastfy
- CORS
- JWT
- zod
- short-unique-id
- .env variables
> Among Others...
#
👨💻 | How to use
### Open your Git Terminal and clone this repository
```git
$ git clone "git@github.com:Samuel-Ricardo/bolao-da-copa_api.git"
```
### Make Pull
```git
$ git pull "git@github.com:Samuel-Ricardo/bolao-da-copa_api.git"
```
You need to have `NodeJS` on your machine and a package manager (`npm`, `yarn`, or other...) to interpret the code and install the dependecies.
> 
```bash
# To install all the dependencies
$ yarn
$ npm install
# To run the project
$ yarn run dev
$ npm run dev
```
#
:octocat: | Author:
