sameer-space / samcorp-commerce

A headless eCommerce platform built to empower businesses with flexible and customizable solutions for online retail.

SamCorp Commerce - Headless eCommerce Platform

Welcome to SamCorp Commerce, a headless eCommerce platform built to empower businesses with flexible and customizable solutions for online retail.

Overview

SamCorp Commerce is designed to provide a seamless and scalable eCommerce experience. With a focus on flexibility, customization, and performance, it offers a range of features and functionalities to meet the diverse needs of businesses in the digital marketplace.

Features

• Headless Architecture: SamCorp Commerce follows a headless architecture, decoupling the frontend and backend to provide greater flexibility and customization options.
• Product Management: Easily manage products, categories, variants, and attributes to create rich and diverse product catalogs.
• User Authentication: Secure user authentication and authorization mechanisms to protect sensitive data and provide a seamless login experience.
• Order Management: Streamlined order processing, tracking, and management for efficient order fulfillment and customer service.
• Flexible API: RESTful API endpoints for seamless integration with third-party systems, enabling a wide range of customizations and integrations.
• Scalable: Built to handle high traffic and scale as your business grows, ensuring consistent performance and reliability.

Installation

To install SamCorp Commerce, follow these steps:

1. Clone the repository:

   git clone https://github.com/Sameer-space/samCorp-Commerce
   

2. Navigate to the project directory:

   cd samCorp-Commerce
   

3. Run npm install in order to install all dependencies:

   npm install
   

4. Configure environment variables:

   cp .env.example .env
   

5. Start the application:

   npm start
   

Configuration

To configure SamCorp Commerce, set the following environment variables in a .env file:

• .env:

  PORT=3000
  MONGODB_URI=mongodb+srv://username:password@your-cluster-url/your-database-name?retryWrites=true&w=majority
  JWT_SECRET=your-jwt-secret-key
  STRIPE_SECRET_KEY=your-stripe-secret-key
  ALGOLIA={"applicationId":"your-application-id","apiKey":"your-api-key","index":"your-index-name"}
  

Documentation

The documentation for SamCorp Commerce can be found in the Postman collection. This collection provides detailed information about the API endpoints, request formats, and response structures.

To try the APIs that are deployed on Render, please use the base URL:

https://samcorp-commerce.onrender.com

This base URL should be used in conjunction with the endpoints specified in the Postman collection for seamless testing and integration.

Contributing

We welcome contributions from the community to enhance SamCorp Commerce. To contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Make your changes and commit them with descriptive messages.
4. Push your changes to your fork.
5. Submit a pull request to the main repository.

Support

If you encounter any issues or have any questions about SamCorp Commerce, please feel free to open an issue. We're here to help!

License

SamCorp Commerce is licensed under the MIT License. Feel free to use, modify, and distribute the software according to the terms of the license.

Author

SamCorp Commerce is developed and maintained by Sameer Sheikh.

You can connect with me on LinkedIn.

---

SamCorp Commerce - Empowering Businesses, Elevating eCommerce