Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/eloi-perez/ecommerce-node-backend


https://github.com/eloi-perez/ecommerce-node-backend

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README 

        
# Ecommerce Node Backend



This is a simple ecommerce backend API to use with your frontend store.



# Starting guide



**New developers welcome**



[Please follow this guide to learn how to get the repository into your computer and how to send your code](https://github.com/Eloi-Perez/guide-collaborating)



## Prerequisite:

- node: ">=16.0.0"

- npm: ">=7.0.0"

- MongoDB installed and running locally or in Atlas



## Style guide:



- no ``;`` at the end of the line

- ``''`` instead of ``""`` on JS code

- 2 spaces indenting

- variable names in camelCase: 	``newVariable``

- new files names in kebab-case:		``new-file``

- new folder names in kebab-case:		``new-folder``



## Git committing guide:



    git add --all

    git commit -m "feat: amazing feature description"



*(use present tense)*



- feat: The new feature you're adding to a particular application

- fix: A bug fix

- style: Feature and updates related to styling

- refactor: Refactoring a specific section of the codebase

- test: Everything related to testing

- docs: Everything related to documentation

- chore: Regular code maintenance, update packages



*Do multiple commits with small features*



## Development:



Use `npm run dev` to start the development server



**But don't forget to create .env file, copy the keys from .env.example and add your config**



*(email config is not needed as the email sending is commented atm for testing new features easily)*