https://github.com/victor-0x29a/legends-back
A back for RPG wiki.
https://github.com/victor-0x29a/legends-back
docker-compose express husky jest jwt nodejs postgresql sequelize typescript yup
Last synced: 3 months ago
JSON representation
A back for RPG wiki.
- Host: GitHub
- URL: https://github.com/victor-0x29a/legends-back
- Owner: victor-0x29a
- Created: 2024-04-26T19:19:28.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-12T06:00:44.000Z (over 1 year ago)
- Last Synced: 2025-07-22T20:46:44.585Z (11 months ago)
- Topics: docker-compose, express, husky, jest, jwt, nodejs, postgresql, sequelize, typescript, yup
- Language: TypeScript
- Homepage:
- Size: 148 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Getting started
This project is the backend to [Primordial Legends Wiki](https://github.com/Primordial-Legends/legends-wiki).
Using [express](https://expressjs.com/pt-br/) using [typescript](https://www.typescriptlang.org/).
# How to install?
For Linux/Windows/Mac:
- Install the latest version from [Node.Js](https://nodejs.org/en)
- Install the latest version from [NPM](https://www.npmjs.com/)
- Install the latest version from [DOCKER](https://www.docker.com/) and [DOCKER-COMPOSE](https://docs.docker.com/compose/)
And now, after install the npm, let's install the [yarn](https://yarnpkg.com/) (Other package manager) running the command:
- `npm i -g yarn`
When the [yarn](https://yarnpkg.com/) 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](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) extension, the [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) and [prettier eslint](https://marketplace.visualstudio.com/items?itemName=rvest.vs-code-prettier-eslint).
Now, configure your vscode for use the "Prettier eslint" as your default formatter.