Skip to content

saymondamasio/ecommerce-api

Repository files navigation

Logo

Ecommerce

Uma api feita para um ecommerce

GitHub top language Made by Repository size GitHub last commit Repository issues GitHub

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

Run in Insomnia

👨🏻‍💻 About the project

Essa API tem como objetivo de administrar produtos e clientes de seu ecommerce. Foi feita uma integrações com Stripe um sistema de pagamentos online e com os Correios para obter informações de entrega.

🚀 Technologies

Technologies that I used to develop this api

💻 Getting started

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

Requirements

Obs.: Docker is required to run the project on a local machine.

Clone the project and access the folder

$ git clone https://github.com/saymondamasio/ecommerce-api.git && cd ecommerce-api

Follow the steps below

# Install the dependencies
$ yarn

# Or create manually the instances databases
docker run --name postgres-db -e POSTGRES_PASSWORD=admin -p 5432:5432 -d postgres
# Don't forget to create the rentx database in postgres before running the project

docker run --name mongo-db -p 27017:27017 -d mongo

docker run --name redis-db -p 6379:6379 -d redis

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

# 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 saymondamasio/ecommerce-api

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'
## or use cli commitlint
$ yarn commit

# 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 Saymon Damásio 👋  See my linkedin

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published