Skip to content

Latest commit

 

History

History
134 lines (94 loc) · 3.17 KB

README.md

File metadata and controls

134 lines (94 loc) · 3.17 KB
Raw

Kollsh - Online Marketplace for Saudi Arabia

Welcome to Kollsh, your go-to online marketplace for buying and selling new and used products in Saudi Arabia. Whether you're looking for the latest gadgets, trendy fashion items, or household essentials, Kollsh offers a convenient and hassle-free way to connect with buyers and sellers across all cities in the country.

Table of Contents

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js and npm installed.
  • MongoDB instance or connection details.
  • Cloudinary API credentials.
  • Mailgun API credentials.

Installation

  1. Clone the repository:

    git clone https://github.com/ibrahimsifat/kollsh-backend.git
cd kollsh-backend

  2. Install dependencies:

    yarn install

  3. Set up your environment variables by creating a .env file based on the provided structure. Make sure to replace placeholders with your actual credentials.

  4. Start the development server:

    yarn run dev

Run Seed

To seed the database with initial data, run the following command:

yarn run seed

After running the seed, you will get the following output:

Seed data was inserted successfully
User Login Credentials: {
  message: 'success',
  accessToken: 'access-token',
  user: {
    id: 'user-id',
    name: 'Ibrahim Sifat',
    username: 'username',
    email: 'ibsifat900@gmail.com',
    avatar: undefined,
    confirmed: true,
    blocked: false
  }
}

Admin Login Credentials: {
  message: 'success',
  accessToken: 'access-token',
  user: {
    id: 'admin-id',
    name: 'Ibrahim Sifat',
    username: 'admin_username',
    email: 'ibrahimsifat.me@gmail.com',
    avatar: undefined,
    confirmed: true,
    blocked: false
  }
}

  1. To run tests, use the following command:

    yarn test

Configuration

Here is the structure of the .env file: .env.example

Documentation

Presentation

Swagger Doc

ER Diagram

API Documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.

Feel free to contribute, report issues, or contact the author Ibrahim Sifat for any questions or suggestions related to the Kollsh project. Thank you for visiting Kollsh!