Getting started

This project is the backend to Primordial Legends Wiki.

Using express using typescript.

How to install?

For Linux/Windows/Mac:

• Install the latest version from Node.Js
• Install the latest version from NPM
• Install the latest version from DOCKER and DOCKER-COMPOSE

And now, after install the npm, let's install the yarn (Other package manager) running the command:

• npm i -g yarn

When the yarn is installed, let's go install all the dependencies from project running the command:

• yarn install

How to run the project?

Run: - docker-compose up -d - yarn dev

Conventional commits for this project

For more clarity in your actions and a good coexistence, use this pattern to name your commits.

• Feat: a new feature
• Patch: update in a exists feature
• Fix: for a fix in a exists feature
• Style: warnings from lint or adjusts in code
• Refactor: upgrades in code, for example: new adjust to more performance

Linter

Please, install on your vscode the eslint extension, the prettier and prettier eslint.

Now, configure your vscode for use the "Prettier eslint" as your default formatter.