dudubernardino/iniciador

Iniciador API Project

An rest api for shoes crud.

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

🏦 About the project

This api contains shoes crud and authentication services.

🚀 Technologies

Technologies that I used to develop this api

• Node.js
• TypeScript
• Nest.js
• TypeORM
• PostgreSQL
• Swagger
• Eslint
• Prettier

💻 Getting started

Requirements

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

Obs.: I recommend to use docker to postgres

Clone the project and access the folder

$ git clone https://github.com/dudubernardino/iniciador && cd iniciador

Follow the steps below

# Install the dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables.
# The aws variables do not need to be filled for dev environment
$ cp .env.example .env

# Create the instance of postgreSQL using docker
$ docker run --name postgres-db -e POSTGRES_USER=iniciador_user -e POSTGRES_PASSWORD=magical_password -p 5432:5432 -d postgres

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

# Run the auth service
$ yarn start:dev:auth

# Well done, project is started!

📚 Docs

I used swagger to document the API. You can use this routes to test the app

• localhost:3001/auth: this route contains the services of the auth.;

Obs.: check the routes that need the auth token

• localhost:3000/api/clients: this route contains the clients services of the api.;
• localhost:3000/api/shoes: this route contains the shoes services of the api.;

To run the tests use the commands below

$ yarn test

$ yarn test:cov

🤔 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 dudubernardino/iniciador

Follow the steps below

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

# 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 Eduardo Bernardino 👋  See my linkedin