Sócio Torcedor API Project

An rest api for fan partner management system. 👨🏼‍💻🏟️

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

🏦 About the project

In recent years, technology has become increasingly relevant to sports. One of the areas where it is widely used is fan management, an important tool for football clubs to connect with their fans and increase revenue. However, current fan management systems face scalability, security, and innovation problems, making it difficult to manage fan programs efficiently and securely.

This project aims to propose a fan management system that solves these problems, analyze the main difficulties of the existing system, and propose technical solutions that meet the needs of fans and sports associations.

Developing efficient fan management systems is important for fan loyalty and engagement, as well as for generating recurring revenue for sports associations. Additionally, proposing solutions to the challenges of scalability, security, and innovation can benefit other companies dealing with large user bases and requiring robust and scalable systems.

🚀 Technologies

Technologies that I used to develop this api

• TypeScript
• Nest.js
• TypeORM
• PostgreSQL
• JWT
• Mercado Pago API
• Docker
• Terraform
• Swagger
• Eslint
• Prettier

💻 Getting started

Requirements

• Node.js
• Yarn or npm
• One instance of PostgreSQL

Obs.: I recommend to use docker

Clone the project and access the folder

$ git clone https://github.com/dudubernardino/socio-torcedor-api && cd socio-torcedor-api

Follow the steps below

# Install the dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
# The aws variables do not need to be filled for dev environment
$ cp .env.example .env

# Create the instance of postgreSQL using docker
$ docker run --name db_postgres -e POSTGRES_USER=docker -p 5432:5432 -d postgres

# To finish, run the api service
$ yarn start:dev

# Well done, project is started!

📚 Docs

I used swagger to document the API. You can use postman to test the app.

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork dudubernardino/socio-torcedor-api

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd socio-torcedor-api

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

After your pull request is merged, you can delete your branch

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with ❤️  by Eduardo Bernardino 👋  See my linkedin