Futebolize API is a robust and scalable RESTful API for soccer management. Provides endpoints for managing teams, players and match schedules, enabling seamless integration with front-end applications and other platforms.
- Manage teams: List, create, update and delete teams, as well as more info about them.
- Manage players: List, create, update and delete players.
- Manage referees: List, create, update and delete referees.
- User authentication: Secure API access using JWT-based authentication.
- API documentation: Swagger-based interactive API documentation.
- Node.js: Server-side JavaScript runtime.
- Express: Web framework for building RESTful APIs.
- Sequelize: ORM for handling database operations.
- SQLite: Lightweight database for development and testing.
- bcrypt: Secure password hashing.
- jsonwebtoken: Token-based authentication.
- dotenv: Environment variable management.
- dotenv-cli: Easy
.envfile handling for different environments in scripts. - swagger-jsdoc & swagger-ui-express: API documentation tools.
- Docker: Containerization for consistent and scalable deployments.
- Install Docker on your machine.
- Clone the repository:
git clone https://github.com/LuanContarin/futebolize-api.git cd futebolize-api - Build the Docker image: (Make sure you have Docker installed)
docker build -t futebolize-api . - Run the Docker container:
docker run -p 8080:8080 --name futebolize-api-container futebolize-api
- Access the API:
- The API will be running at
http://localhost:8080 - The API documentation will be running at
http://localhost:8080/api-docs.
- The API will be running at
