https://github.com/co-cart/cocart-api-reference-docs

API Reference for CoCart, CoCart Pro and it's add-ons.
https://github.com/co-cart/cocart-api-reference-docs

cocart documentation rest-api slate woocommerce wordpress-plugin

Last synced: 19 days ago
JSON representation

API Reference for CoCart, CoCart Pro and it's add-ons.

• Host: GitHub
• URL: https://github.com/co-cart/cocart-api-reference-docs
• Owner: co-cart
• Created: 2017-02-27T16:20:05.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-22T21:21:10.000Z (4 months ago)
• Last Synced: 2024-12-25T05:44:25.235Z (24 days ago)
• Topics: cocart, documentation, rest-api, slate, woocommerce, wordpress-plugin
• Language: SCSS
• Homepage:
• Size: 2.44 MB
• Stars: 5
• Watchers: 2
• Forks: 8
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
CoCart Documentation




[![WordPress Plugin Page](https://img.shields.io/badge/WordPress-%E2%86%92-lightgrey.svg?style=flat-square)](https://wordpress.org/plugins/cart-rest-api-for-woocommerce/)

[![WordPress Plugin Version](https://img.shields.io/wordpress/plugin/v/cart-rest-api-for-woocommerce.svg?style=flat)](https://wordpress.org/plugins/cart-rest-api-for-woocommerce/)

[![WordPress Plugin Downloads](https://img.shields.io/wordpress/plugin/dt/cart-rest-api-for-woocommerce.svg)](https://wordpress.org/plugins/cart-rest-api-for-woocommerce/)

This repository manages the documentation for CoCart.

If you would like to contribute to the documentation to either correct a mistake, maybe add another language or something else. Then please follow these [contribution guidelines](https://github.com/co-cart/co-cart-docs/blob/master/CONTRIBUTING.md).

## Getting Started

### Requirements

You're going to need:

 - **Linux or macOS** — Windows may work, but is unsupported.

 - **[Ruby, version 2.5 or newer](https://www.ruby-lang.org/en/)**

 - **[Bundler](https://bundler.io/)** — If Ruby is already installed, but the `bundle` command doesn't work, just run `gem install bundler` in a terminal.

 - **[NodeJS](https://nodejs.org/en/)**

### Getting Set Up

1. Fork this repository on GitHub.

2. Clone *your forked repository* (not this original one) to your hard drive with `git clone https://github.com/YOURUSERNAME/co-cart-docs.git`

3. `cd co-cart-docs`

4. Initialize and start Slate. You can either do this locally, or with Vagrant:

```shell

# either run this to run locally

bundle install

bundle exec middleman server ## Load server process for development.

bundle exec middleman build  ## Just build the files.

# OR run this to run with vagrant

vagrant up

```

You can now see the docs at http://localhost:4567.

## CoCart Channels

We have different channels at your disposal where you can find information about the CoCart project, discuss it and get involved:

[![Twitter: cocartapi](https://img.shields.io/twitter/follow/cocartapi?style=social)](https://twitter.com/cocartapi) [![CoCart JS Lib Github Stars](https://img.shields.io/github/stars/co-cart/co-cart-docs?style=social)](https://github.com/co-cart/co-cart-docs)



  
📖 Docs: this is the place to learn how to use CoCart API. Get started!



  
🧰 Resources: this is the hub of all CoCart resources to help you build a headless store. Get resources!



  
👪 Community: use our Slack chat room to share any doubts, feedback and meet great people. This is your place too to share how are you planning to use CoCart!



  
🐞 GitHub: we use GitHub for bugs and pull requests, doubts are solved with the community.

  
🐦 Social media: a more informal place to interact with CoCart users, reach out to us on Twitter.



  
💌 Newsletter: do you want to receive the latest plugin updates and news? Subscribe here.





> The documentation is powered by [Slate](https://github.com/lord/slate).