This is a project developed at Trybe's Back-End Module.
Trybe Football Club is a full stack application to access information about the Brazilian football championship. It were developed using a node server and Sequelize ORM to manipulate a MySQL database.
React frontend and all config files except for the backend/frontend dockerfile were provided by Trybe, the application backend was developed from scratch.
- Trybe Football Club
- Summary
- Context
- Technologies and Tools
- Notes
- Git and Commits
- Lint
- Installing and running the app
- Documentation
In the application you can do:
- Log in to the System.
- View team matches.
- Create and update a match only when you are logged in.
- View teams leaderboard.
This project used the following technologies and tools:
- Node | Javascript Runtime Environment
- Express | Web Framework for NodeJS
- Sequelize | Object–relational Mapping
- BcryptJS | Password Hashing
- JWT | JSON Web Token
- Mocha | JS Test Framework
- Sinon | Test Spies, Stubs and Mocks
- Chai | Asserts
- This project used the Conventional Commits specification with some types from Angular convention.
- The project was developed following the Clean Code standards specified by Trybe's Lint.
To run this project properly, docker-compose version should be at 1.29 or higher and node version should be at 16.14.0 LTS or higher.
Data to log into frontend app
admin
email: admin@admin.com
password: secret_admin
user
email: user@user.com
password: secret_user
git clone git@github.com:Thesamuel01/TFC.git
cd TFC
npm install
npm run compose:up
http://localhost:3000
npm run compose:down
* To run this app without docker you need a running MYSQL server.
cd TFC
npm install
cd app/backend
Set your environment variables in .env.example file according to your development environment and then change its name to .env
JWT_SECRET=
APP_PORT=
DB_USER=
DB_PASS=
DB_HOST=
DB_PORT=
npm start
cd app/frontend
npm start