E-commerce API

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

👨🏻‍💻 About the project

This project is a REST API of a fictitious ecommerce.

🚀 Technologies

Technologies that I used to develop this API:

• Node.js
• TypeScript
• Express
• Mongoose
• Stripe
• Jest
• JWT-token
• CryptoJS
• Tsyringe
• Husky
• Commitlint
• Commitizen
• Lint Staged
• Babel
• Eslint
• Prettier

💻 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 MongoDB

Clone the project and access the folder

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

Follow the steps below

# Install the dependencies
$ yarn

# Make a copy of '.env.example' to '.env'
# and set with YOUR environment variables
$ cp .env.example .env

# To finish, run the API service
$ yarn 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 GabrielCordeiroDev/ecommerce-api

Follow the steps below

# Clone your fork
$ git clone your-fork-url && cd ecommerce-api

# 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 Gabriel Cordeiro 👋  See my Linkedin