devixid/miolica-backend

E-commerce Backend

Contributing Guidelines · Submit an Issue

E-commerce Backend

This is an application backend system from the E-commerce-model api project, if you want to see the Frontend of this application, you can visit the github repository link:

Frontend App

Technology Used

1. 

   ExpressJS

2. 

   MongoDB

3. 

   NodeJS

How to use

If you want to use this project to view it, you can follow these steps and please copy and paste it in your terminal.

git clone https://github.com/Alwisteins/e-commerce-model.git

cd e-commerce-model

The second step, please follow the npm command below to install all package dependencies (node_modules/).

# just install it
npm install

# install and update dependencies to
npm install && npm update

If you are a yarn or pnpm user, you can use the yarn or pnpm package manager to install it.

# use yarn
yarn install

# use pnpm
pnpm install

The last step, follow the command below to open a local development server with the address http://localhost:88 and then copy it to your web browser.

# use npm ro run
npm run dev

# use yarn yarn
yarn dev

# or use pnpm to run
pnmm dev

Api Documentation

• Comming Soon

How To Commit in this Project

in this project, we don't use old way to commit a changes We use git hooks for commiting and linting before changes are commited, before run this command please install yarn package manager because git hooks use yarn for linting before this commited let's see how it works

# use npm to commit changes
npm run commit

# use yarn to commit changes
yarn commit

# or use pnpm to commit changes
pnpm commit

and favorit part push that into branch you've created before doing changes, please see how to contributing section of project

  git push origin <feat/feature_name>

Contributing

Contributing Guidelines Read through our Contributing Guidelines to learn about how contribute to this project.

All Contributors

Thank you for contributing to this project, here are some amazing contributors!

License

This project is open-sourced software licensed under the MIT license.

Happy Coding.