https://github.com/qloapps/user-guide
https://github.com/qloapps/user-guide
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/qloapps/user-guide
- Owner: Qloapps
- Created: 2025-01-27T13:46:40.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-04-02T14:05:25.000Z (about 1 year ago)
- Last Synced: 2025-04-02T15:22:35.269Z (about 1 year ago)
- Size: 49.3 MB
- Stars: 2
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# QloApps User Guide
The online version of this documentation is hosted at [https://docs.qloapps.com](https://docs.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).