https://github.com/aureuserp/dev-docs

Dev docs
https://github.com/aureuserp/dev-docs

Last synced: 5 months ago
JSON representation

Dev docs

• Host: GitHub
• URL: https://github.com/aureuserp/dev-docs
• Owner: aureuserp
• Created: 2025-03-10T13:42:45.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2026-01-12T10:14:38.000Z (5 months ago)
• Last Synced: 2026-01-12T18:47:20.879Z (5 months ago)
• Language: Vue
• Size: 3.67 MB
• Stars: 2
• Watchers: 1
• Forks: 10
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# Aureus Erp Documentation

You can find the online version of the Aureus Erp documentation at [https://devdocs.aureuserp.com](https://devdocs.aureuserp.com).

## Contribution guide

For contributing to the docs, you first need to set up the project,

- Fork the repository.

- Clone your fork.

- Follow the [Install Dependencies](#Install-dependencies) section.

Make sure your PR follows all these points,

- Before writing the docs just make sure to check that if that topic is already written or not.

- Make sure your markdown indentation should be proper. You can install `mark-down` lint also. This will help you to follow the markdown conventions.

- If you are creating new files for the docs, then make sure the filename should be `kebab-case`. For e.g. `file-1.md`, `file-2.md`.

## Install dependencies

- Run the following command,

  ```sh

  npm install

  ```

- Run the docs locally,

  ```sh

  npm run docs:dev

  ```

- Open your browser and go to [http://localhost:5173](http://localhost:5173).