Trybe Futebol Clube

This is a project designed for a soccer website, it is a full dockerized app.

Stacks used

  TypeScript, MYSQL, MOCHA, CHAI, EXPRESS, JSONWEBTOKEN, SINON, BCRYPT, JOI, SEQUELIZE, HTTP-STATUS-CODES

Turning the app on

Run it on docker (LINUX)

Clone the project

  git clone [email protected]:xafixav/trybe-futebol-clube.git

Go to the project directory

  cd trybe-futebol-clube

Start the server

  npm run compose:up

<details>
<summary><strong>If you want to turn it off</strong></summary>

## Stop the server

```
  npm run compose:down
```

</details>

Connecting to the app

The website will be hosted on

localhost:3000

The backend will be hosted on

localhost:3001

Endpoints

API Reference

      {
        username: 'Admin',
        role: 'admin',
        email: '[email protected]',
        password: '$2a$08$xi.Hxk1czAO0nZR..B393u10aED0RQ1N3PAEXQ7HxtLjKPEZBu.PW', // secret_admin
      },
      {
        username: 'User',
        role: 'user',
        email: '[email protected]',
        password: '$2a$08$Y8Abi8jXvsXyqm.rmp0B.uQBA5qUz7T6Ghlg/CvVr/gLxYj5UAZVO', // secret_user
      },

Login

  POST /login

Body	Type	Description
email	string	Required. Your Email
password	string	Required. Your password

Get Matches

  GET /matches

Readme 🚧

Sorry for the unfinished readme, I`ll finish soon as possible. If you wanna know more endpoints, please check the routes files.

  cd app && cd backend && cd src && cd Routes

Every file in this folder, contains the route and the methods it will call. (Controller methods)