api.md

Application Logo

Title

Short slogan

About the project   |    Technologies   |    Getting started   |    How to contribute   |    License

👨🏻‍💻 About the project

• Brief explanation about the project

To see the web client, click here: PROJECT_NAME Web
To see the mobile client, click here: PROJECT_NAME Mobile

🚀 Technologies

Technologies that I used to develop this api

• Node.js
• TypeScript
• Express
• Multer
• TypeORM
• JWT-token
• uuid v4
• PostgreSQL
• Date-fns
• Jest
• SuperTest
• Husky
• Commitlint
• Commitizen
• Eslint
• Prettier
• EditorConfig

💻 Getting started

Import the Insomnia.json on Insomnia App or click on Run in Insomnia button

Requirements

• Node.js
• Yarn or npm
• One instance of PostgreSQL

Obs.: I recommend use docker

Clone the project and access the folder

$ git clone https://github.com/EliasGcf/NOME_DO_REPO.git && cd NOME_DO_REPO

Follow the steps below

# Install the dependencies
$ yarn

# Create the instance of postgreSQL using docker
$ docker run --name project-postgres -e POSTGRES_USER=docker \
              -e POSTGRES_DB=project -e POSTGRES_PASSWORD=docker \
              -p 5432:5432 -d postgres

# Make sure the keys in 'ormconfig.json' to connect with your database
# are set up correctly.

# Once the services are running, run the migrations
$ yarn typeorm migration:run

# To finish, run the api service
$ yarn dev:server

# Well done, project is started!

🤔 How to contribute

Make a fork of this repository

# Fork using GitHub official command line
# If you don't have the GitHub CLI, use the web site to do that.

$ gh repo fork EliasGcf/NOME_DO_REPO

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd NOME_DO_REPO

# Create a branch with your feature
$ git checkout -b my-feature

# Make the commit with your changes
$ git commit -m 'feat: My new feature'

# Send the code to your remote branch
$ git push origin my-feature

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

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Made with 💜  by Elias Gabriel 👋  See my linkedin