Skip to content

LuanContarin/futebolize-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Futebolize Logo

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.

📰 Features

  • 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.

⚙️ Technologies

  • 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 .env file handling for different environments in scripts.
  • swagger-jsdoc & swagger-ui-express: API documentation tools.
  • Docker: Containerization for consistent and scalable deployments.

▶️ How to run

Prerequisites

  • Install Docker on your machine.
  1. Clone the repository:
    git clone https://github.com/LuanContarin/futebolize-api.git
    cd futebolize-api
  2. Build the Docker image: (Make sure you have Docker installed)
    docker build -t futebolize-api .
  3. Run the Docker container:
    docker run -p 8080:8080 --name futebolize-api-container futebolize-api
  4. Access the API:
    • The API will be running at http://localhost:8080
    • The API documentation will be running at http://localhost:8080/api-docs.

About

A RESTful API for soccer management built with Node,JS.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors