Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wso2/docs-ob-toolkit-cds
This repository contains the source code for WSO2 Open Banking Toolkit - CDS documentation.
https://github.com/wso2/docs-ob-toolkit-cds
documentation mkdocs open-banking
Last synced: 2 months ago
JSON representation
This repository contains the source code for WSO2 Open Banking Toolkit - CDS documentation.
- Host: GitHub
- URL: https://github.com/wso2/docs-ob-toolkit-cds
- Owner: wso2
- License: apache-2.0
- Created: 2021-11-15T08:53:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-07T03:09:17.000Z (2 months ago)
- Last Synced: 2024-11-07T04:19:24.530Z (2 months ago)
- Topics: documentation, mkdocs, open-banking
- Language: CSS
- Homepage: https://cds.ob.docs.wso2.com/
- Size: 16.3 MB
- Stars: 32
- Watchers: 15
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# WSO2 Open Banking CDS Toolkit Documentation
This repository contains the source code for WSO2 Open Banking Toolkit - CDS documentation
| Branch | Build Status |
| :------------ |:-------------
| master | [](https://wso2.org/jenkins/view/Dashboard/job/docs/job/docs-ob-toolkit-cds/) |
## Prerequisites
To run the project locally, it requires [python](https://www.python.org/downloads/) & [pip](https://pypi.org/project/pip/).
### Install Python
Check if you already have Python installed by running the following command.
```bash
$ python --version
Python 2.7.10
```
If you receive a response similar to the one shown above, `Python 2.7.10` is your default version.
You should also check if you have Python 3 installed.
```bash
$ python3 --version
Python 3.8.0
```
If you don't seem to have `Python` installed, grab the latest release from the [official downloads page](https://www.python.org/downloads/).
### Install pip
pip is already installed if you are using Python 2 >=2.7.9 or Python 3 >=3.4 downloaded from [python.org](https://www.python.org/) or if you are working in a [Virtual Environment](https://packaging.python.org/tutorials/installing-packages/#creating-and-using-virtual-environments) created by [virtualenv](https://packaging.python.org/key_projects/#virtualenv) or [pyvenv](https://packaging.python.org/key_projects/#venv). Just make sure to [upgrade pip](https://pip.pypa.io/en/stable/installing/#upgrading-pip).
#### Installing with get-pip.py
To install pip with `curl`, execute the following command. Alternatively you can download `get-pip.py` by clicking [here](https://bootstrap.pypa.io/get-pip.py).
```bash
$ curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py
```
Then run the following command in the folder where you have downloaded get-pip.py
```bash
$ python get-pip.py
```
## Run project locally (Dev Mode)
**Clone the repo**
```bash
$ git clone https://github.com/wso2/docs-ob-toolkit-cds.git
```
**Install the dependencies**
```bash
$ cd docs-ob-toolkit-cds && pip install -r requirements.txt
```
**Run mkdocs**
Execute the following command from inside the ``.
```bash
$ cd en && mkdocs serve
```
## License
Licenses this source under the Apache License, Version 2.0 ([LICENSE](LICENSE)), You may not use this file except in compliance with the License.