smash

This project is based on the competitive scene of the video game series Super Smash Bros. created (but not necessarily supported) by Masahiro Sakurai. It's purpose is to learn how to built loosely coupled applications. This project will be handled with microservices architecture, where two different services will be managed with Docker and requests will go through an API gateway made in GraphQL.

Technologies

• Node.js
• TypeScript
• Hapi.js
• Express
• GraphQL
• MongoDB
• PostgreSQL
• Jest
• CircleCI
• Docker

Minimum setup needed to run the project

• Clone the repository:

  git clone https://github.com/gabrielurenah/smash.git

You need to have docker and docker-compose installed to run this project. If you don't have it installed you can follow this guide.

• After that open your terminal of preference and navigate to the directory you cloned this project. And type the following command:

  docker-compose up

Scripts used on the project

general commands

• npm run lint: Shows linting errors and warnings following linting rules
• npm run prettier: Formats files using prettier rules
• npm run up: Starts the project in development mode
• npm run upd: Starts the project in development as a daemon
• npm run dev: Builds the containers and starts the project
• npm run stop: Stops the project and saves the containers and node_modules

api-gateway

• npm run watch: Starts the gateway in a development environment

character-service

• npm run watch: Starts the application in a development environment

players-service

• npm run watch: Starts the application in a development environment
• npm run db:migrate: Runs the migrations on the database
• npm run db:migrate:undo: Runs the rollback on the database

Git style guidelines

For branch names go with the following (# -> Ticket #):

• SMASH-#-FEAT: a new feature
• SMASH-#-FIX: a bug fix
• SMASH-#-DOCS: changes to documentation
• SMASH-#-STYLE: formatting, missing semi colons, etc.
• SMASH-#-REFACTOR: refactoring production code
• SMASH-#-TEST: adding tests, refactoring test; no production code change
• SMASH-#-CHORE: updating build tasks, package manager configs, etc; no production code change

For Pull Request main title/commit use the following:

Follow the guidelines in the gitmoji page👨‍💻👩‍💻**

Or follow this guidelines:

• 🔥feat: new feature
• 🎊fix: bug fix
• 📝docs: documentation
• ✨style: formatting, missing semi colons, etc
• 🎬refactor: refactoring production code
• 🧪test: adding tests, refactoring test
• 🤖chore: updating build tasks, package manager configs, etc