Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/abdalftahsalem/store-node-js

Back end store with node JS . contain cart , favorite , address , category , sub category , coupon order and review
https://github.com/abdalftahsalem/store-node-js

Last synced: about 2 months ago
JSON representation

Back end store with node JS . contain cart , favorite , address , category , sub category , coupon order and review

Awesome Lists containing this project

README

        

# Store Node.js API

## Table of Contents

- [Introduction](#introduction)
- [Technologies](#technologies)
- [Installation](#installation)
- [Database Setup](#database-setup)
- [Firebase Setup](#firebase-setup)
- [Usage](#usage)
- [API collection](#api-collection)
- [Contributing](#contributing)

## Introduction

Provide a brief introduction to the project. Mention its purpose, features, and any other essential details.

## Technologies

List the main technologies used in the project, such as:

- Node.js
- Express.js
- Sequelize
- MySQL

## Installation

To install the required dependencies, run the following command:

```bash
npm install
```

## Database Setup

Before running the application, you need to set up the MySQL database and configure the connection.

- Create a `.env` file in the root directory of the project.
- Add the following environment variables to the `.env` file:
- `DB_DATABASE` - the name of the database
- `DB_USERNAME` - the username for the database
- `DB_PASSWORD` - the password for the database

## Firebase Setup

Before running the application, you must set up the Firebase Admin SDK and configure the connection.

- In `.env` add the following environment variables:
- TYPE=
- PRJECT_ID=
- PRIVET_KEY_ID=
- private_key=
- CLIENT_EMAIL=
- CLIENT_ID=
- AUTH_URI=
- TOKEN_URI=
- AUTH_PROVIDER_x509_CERT_URL=
- CLIENT_x509_CERT_URL=
- UNIVERSE_DDMAIN=
- Storage_Bucket=

## Usage

To run the application, run the following command:

```bash
npm start
```

## API collection

The API collection is available at the following link : [here](https://github.com/AbdAlftahSalem/Store-node-js/blob/main/Store%20NodeJS.postman_collection.json)

## Contributing

Contributions are welcome. Feel free to submit a Pull Request.