https://github.com/qloapps/qloapps-docs
https://github.com/qloapps/qloapps-docs
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/qloapps/qloapps-docs
- Owner: Qloapps
- Created: 2021-06-04T07:55:10.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2025-07-09T11:10:29.000Z (11 months ago)
- Last Synced: 2025-07-09T12:26:03.397Z (11 months ago)
- Language: Shell
- Homepage: https://devdocs.qloapps.com/
- Size: 10 MB
- Stars: 1
- Watchers: 3
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# QloApps Development Documentation
The online version of this documentation is hosted at [https://devdocs.qloapps.com](https://devdocs.qloapps.com/).
## Contribution guide
Contributions are more than welcome! To start contributing to this documentation, you need to deploy it locally and make the required changes. Here is how to deploy:
- Fork this repository.
- Clone your fork.
- Follow the [Install dependencies](#Install-dependencies) section.
Before making a contribution using a pull request make sure:
- If adding a new page, its topic has not been covered already.
- To use proper terminology as used in this documentation when referring to parts of QloApps.
- To use `kebab-case` when adding a new file. For example, `new-file-one.md`, `new-file-two.md` etc.
Follow VuePress official guide at [https://vuepress.vuejs.org/guide](https://vuepress.vuejs.org/guide/) for further help.
## Install dependencies
- Clone the repository somewhere on your system:
```
git clone https://github.com/Qloapps/qloapps-docs.git
```
- Switch to the `qloapps-docs` directory:
```
cd qloapps-docs
```
- Install all dependencies:
```
npm install
```
- Build and deploy your repository:
```
npm run docs:dev
```
- Open your browser and go to [http://localhost:8080](http://localhost:8080).