SquadsZ - Server

About

Project that provides the API to be used in squadsz client

🚀 Technologies

• ✔️ Node
• ✔️ PostgreSQL
• ✔️ Docker
• ✔️ Docker compose

ℹ️ How To Use

ESLint and Prettier

You need to have 3 plugins installed in your text editor to keep a pattern in the project: ESLint, Prettier and EditorConfig.

These plugins are already configured in the project in the prettier.config.js, .eslintrc.json and editorconfig files.

Environment Variables

If you want to set the environment variables, create a .env file based on the .env.example template

Installation

To modify (locally) this project, you will need Node, GIT and docker-compose installed on your computer.

With these tools in hand, follow the steps below

# Clone this repository
$ git clone https://github.com/IgorSantoss/squadsz

# Go to the repository cloned
$ cd squadsz

# Install dependencies
$ make install

# Start server
$ make up

Done! Now you have this application in your computer.

Commands Info

# Install dependencies
$ make install

# Build image
$ make build

# Up and start docker container
$ make up

# Stop and remove docker container
$ make down

# Start docker container (already created)
$ make start

# Stop docker container (already created)
$ make stop

# Restart docker
$ make restart

# See logs
$ make logs

# Compile scss files in real time
$ make dev

🤝 Contributing

To contributing to this project, follow the steps bellow.

1. Fork the Project;
2. Create your Feature Branch (git checkout -b new-branch)
3. Commit your Changes (git commit -m 'DESCRIPTION OF CHANGES')
4. Push to the Branch (git push origin new-branch)
5. Open a Pull Request

📝 License

This project is under the MIT license. See the LICENSE file for more details.

---

Made with ❤️ by Vitor Martins ✌