OmranAbazid / Capi

CAPI is an API-first, headless commerce solution built using React and Express.

CAPI

CAPI is a commerce API and an admin panel to make it easy for developers to create custom ecommerce applications for any platform.

Table of Contents

• About the Project
  • Why Capi
  • Features
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

Why Capi?

Most of the already available e-commerce applications are huge and hard to customize. Sometimes, you build an e-commerce application using woocommerce/Shopify and then the customer asks for a feature that is very hard or not even possible to implement which forces you to move to another solution. Therefore, it is much easier to start with something very simple and add the features that you need along the way and that is exactly what Capi provides. Capi is a very simple yet very powerful e-commerce API. Developers who know JavaScript can easily understand the codebase since it is written entirely in JavaScript using the most common and proven technologies. Since themes are hard to build, Capi is headless which means just use the API and build whatever type of store you want.

Features

• Headless commerce: Build mobile apps, customize storefronts and externalize processes
• Dashboard: Administrators have good control of orders, and products
• Products: Options, variants, attributes, Product categories, Inventory and stock management
• Cart: Advanced payment and tax options
• Users: User authentication and roles are already implemented
• Multivendor: Capi can be used as a marketplace with multiple stores

If you like the software, please give us a star! 🌟

Built With

API

• Express
• MongoDB

Admin

• React
• Ant Design

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

MongoDB is installed on your machine and the credentials matches serverConfig.js available in the root directory

Installation

1. Clone the Capi

git clone https://github.com/OmranAbazid/Capi.git

2. Install NPM packages

yarn install

3. Initialize the database with some data

yarn setup

4. Start the API and the admin panel in two seperate terminals

yarn start-api
yarn start-admin

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

The admin panel is still in the early stage of development and there are alot of stuff to be done. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Omran Abazid - @omran_abazid

Project Link: https://github.com/OmranAbazid/Capi

Acknowledgements

Part of the ecommerce API was ported from another open source project called Cezirn