ItaloCobains / Waifus-Api-Rest-Ts

REST API for information management and information return, open source project.

API REST - Waifus 🏪

Tecnologias   |    Projeto   |    Rodando   |    Como contribuir   |    Licença   |   

Tecnologias 🖥️

Project 📕

Simple api for otakus

building on NodeJS with TypeScript, running on server local

Running the App 🚀

With the .env.example file, rename it to .env and fill in the information that is requested:

# APP
PORT=
BASE= (example http://localhost:4000)

DB_CONN_STRING=
DB_NAME=
GAMES_COLLECTION_NAME=

Keep in mind that you own:

- a code editor
- NodeJS
- Mongodb Server (If running natively)

Running natively 🌅

1. First install all dependencies, use the package manager to your liking.

npm install
# ou
yarn install

2. Remember to have a Mongodb server running on your machine.

3. Now open the current directory and type in the terminal:

npm run dev
# ou
yarn dev

🤔 how to contribute

• Fork this repository;
• Create a branch with your feature: git checkout -b minha-feature;
• Commit your changes: git commit -m 'feat: Minha nova feature';
• Push to your branch: git push origin minha-feature.

After your pull request is merged, you can delete your branch.

🔖 License

If you want to check the project's license, just look at this file LICENSE