Xerataw/Gigz

Gigz

Connect artists with venues to organize the best gigs !

Overview

This repository is a mono-repository hosting the front-end and back-end project. The goal of this mono-repository is to more easily collaborate and work and all the areas of the project.

Project installation 📥

Requirements

• nodejs (nodenv installation recommended)
• make
• just

Commit linter, code linter and formatter installation

Once the repository is cloned, run the command:

npm run setup

Once the setup is finished, you should be able to run the commands:

npm run lint

npm run format

To locally launch ESLinter or Prettier on both projects when needed.

Setup Ionic (front) project

See installation steps on the frontend README

Setup Express + database (back) project

See installation steps on the backend README

How to contribute 🤝

Committing your code

When you want to commit your changes with the command:

git commit -m "<your_conventional_message>"

Those hooks will be triggered over the staged files:

1. ESLinter will perform the linting and the commit will fail if it returns an error.
2. Prettier will automatically format the code inside the files.

The commit linter follows the conventionnal commit convention.

Pull requests

After developing your feature, you will have to push your branch and create a pull request. For the pull request to be accepted and merged to the master branch, those conditions should be fulfilled:

• All the workflows should succeed
  • Dependencies vulnerabilities checker
  • Code vulnerabilities checker
• At least one reviewer should approve the pull request