https://github.com/ekoindia/eko-developer-docs

[WIP] Open-source developer portal for Eko. Build with Eko!
https://github.com/ekoindia/eko-developer-docs

api developer-documentation eko financial-services open-source rest-api

Last synced: 1 day ago
JSON representation

[WIP] Open-source developer portal for Eko. Build with Eko!

• Host: GitHub
• URL: https://github.com/ekoindia/eko-developer-docs
• Owner: ekoindia
• Created: 2020-05-10T09:22:21.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T05:29:12.000Z (almost 2 years ago)
• Last Synced: 2023-03-23T05:12:02.490Z (over 1 year ago)
• Topics: api, developer-documentation, eko, financial-services, open-source, rest-api
• Language: HTML
• Homepage: https://ekoindia.github.io/eko-developer-docs
• Size: 4.11 MB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 25
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Eko Developer Portal

Open-source developer portal for Eko. Read developer guides and API docs. Build with Eko! 

### Installation

```

$ yarn

```

### Local Development

```

$ yarn start

```

This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.

### Build

```

$ yarn build

```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

### Deployment

```

$ GIT_USER= USE_SSH=true yarn deploy

```

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

### Updates + Installs

Update docusaurus to most recent version

```

$ yarn upgrade docusaurus --latest

```

Install Redoc

```

$ npm install redoc --save-dev

```

Install peer dependencies required by ReDoc

```

$ npm i react react-dom mobx styled-components core-js

```

### Redocusaurus (Redoc + Docusaurus)

This link (https://gist.github.com/rohit-gohri/b1a19f37702cfe4a6c5a47933a11785b) shows how to import Redoc into a react component and pass in a yaml/json OpenAPI doc

Also, redoc.css is used to ensure the API Docs has the same css styles as the rest of the docusaurus pages