https://github.com/29next/developer-docs
Developer documentation for 29 Next platform and APIs.
https://github.com/29next/developer-docs
developer-docs developer-documentation ecommerce ecommerce-api ecommerce-platform
Last synced: 9 months ago
JSON representation
Developer documentation for 29 Next platform and APIs.
- Host: GitHub
- URL: https://github.com/29next/developer-docs
- Owner: 29next
- Created: 2023-01-24T08:57:10.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T06:38:14.000Z (9 months ago)
- Last Synced: 2025-04-11T20:48:12.945Z (9 months ago)
- Topics: developer-docs, developer-documentation, ecommerce, ecommerce-api, ecommerce-platform
- Language: JavaScript
- Homepage: https://developers.29next.com
- Size: 1.99 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
29 Next Developer Docs
29 Next's developer documentation portal, built with Docusaurus and Stoplight.
Explore the Docs »
### Built With
- [Docusaurus](https://docusaurus.io/)
- [Stoplight Elements](https://stoplight.io/open-source/elements)
- [Algolia](https://www.algolia.com/)
- [Tailwind](https://tailwindcss.com/)
## Getting Started
This section describes how you can get our documentation portal up and running on your machine.
### Prerequisites
- [node](https://nodejs.org/en/)
- [npm](https://www.npmjs.com/)
### Installation
**Clone the repo**
```sh
git clone git@github.com:29next/developer-docs.git
```
**Install NPM packages**
```sh
npm install
```
**Run the app**
```sh
npm start
```
## Update API Docs
API Reference docs for [Admin API](https://developers.29next.com/docs/api/admin/reference/) and [Campaigns API](https://developers.29next.com/docs/api/campaigns/reference/#/) use Open API Spec files downloaded from their respective apps.
### Update Script
Included in the docs is a python script to automatically fetch the latest versions of the Open API Spec files and update them for the developer docs portal usage.
**Install Dependenceis**
```sh
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
```
**Run Update**
```sh
cd tools/
python update_api_docs.py
```