An open API service indexing awesome lists of open source software.

https://github.com/thiagohrcosta/soccer-api


https://github.com/thiagohrcosta/soccer-api

postgresql postman pundit rails rspec ruby

Last synced: 2 months ago
JSON representation

Awesome Lists containing this project

README

          

# Soccer API
![main](https://res.cloudinary.com/dloadb2bx/image/upload/v1621355630/soccerAPi_e604ov.png)

## Technologies used in this project
Ruby Rails Postgres Postman

### Gems used:

- Pundit;
- Simple_token_authentication;

## API Request
![api](https://res.cloudinary.com/dloadb2bx/image/upload/v1621355451/api_vzv6ce.gif)

## Tests
To implement tests on this project was used Rspec gem.
![tests](https://res.cloudinary.com/dloadb2bx/image/upload/v1621563038/teste1_fgcz99.gif)
## How to run this project?
This project was building using the **backend as API**, because of that after download, you need to open the main folder and run `rails s` to start the backend API. After that, you can use Postman to do get and request.

- The backend will be running on `localhost:3000`
- The API is running on path `localhost:3000/api/v1/players`

## Development routine

**May 15**

- Project created in Rails;
- Model Player created;
- Pundit added;
- Folder API created;
- API base controller created;
- API routes created;
- Player controller with policy_scope added;
- Views (JSON) created;
- Player seeds created;

**May 17**

- Pundity policy created;
- Second route /players/:id created;
- Migration to add tolken to user created;
- Update policies

**May 18**

- Create route added;
- Changes policy to allow user to POST;
- Fix typo on seed "Borussia Dortmund";

**May 20**
- Tests added with Rspec;