QR Connect API

The QR connect api is an ecommerce website

Table of Contents

• Features
• Prerequisites
• Installation
• Usage
• API Endpoints
• Testing
• NPM Commands
• Contributing
• License

Features

• Ecom website

Prerequisites

Before running this project, ensure you have the following prerequisites:

• NodeJS v16+
• Mongodb
• Typescript

Installation

1. Clone the repository:

   git clone https://github.com/splashray/QR_connect-api.git

2. Install the dependencies:

   cd QR_connect-api
   npm install

3. Configure the environment variables:

   • Rename the .env.example file to .env.
   • Modify the .env file and update the necessary variables.

4. Start the server:

   npm start

Usage

API Documentation

The API documentation is available here

Testing

😁 Coming soon!!!

NPM Commands

• npm start: Starts the server.
• npm test: Runs the tests. (WIP)
• npm run lint: Performs linting checks. (WIP)
• npm run dev: Starts the server in development mode with automatic reloading.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch: git checkout -b feature/your-feature.
3. Make your changes and commit them: git commit -m 'Add some feature'.
4. Push the changes to your branch: git push origin feature/your-feature.
5. Submit a pull request.

License