https://github.com/bagisto/bagisto-crm-docs

https://github.com/bagisto/bagisto-crm-docs

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/bagisto/bagisto-crm-docs
• Owner: bagisto
• Created: 2021-06-16T12:13:21.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-06-22T11:52:32.000Z (over 3 years ago)
• Last Synced: 2024-02-24T15:34:44.552Z (9 months ago)
• Language: Shell
• Size: 5.83 MB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Krayin CRM Documentation

You can find the online version of the Krayin CRM documentation at [https://devdocs.krayincrm.com](https://devdocs.krayincrm.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:8080](http://localhost:8080).