https://github.com/codeboxrcodehub/comforterpdocs

https://github.com/codeboxrcodehub/comforterpdocs

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/codeboxrcodehub/comforterpdocs
• Owner: codeboxrcodehub
• License: mit
• Created: 2024-12-05T12:03:21.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2024-12-23T10:59:16.000Z (24 days ago)
• Last Synced: 2024-12-23T11:35:13.013Z (24 days ago)
• Language: JavaScript
• Size: 203 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
Comfort ERP

  
A docs template built using VitePress

  
This repository serves as a resource for the tutorial, How to Build a Modern Documentation Site with VitePress posted on freeCodeCamp



## Run project locally 

Use this command below to boot this project locally.

```bash

git clone https://github.com/codeboxrcodehub/comforterpdocs.git

cd Comfort ERP

npm install

npm run docs:dev

```

Visit [https://localhost:5173](https://localhost:5173) to see your site

## Build

You may run this command to build the docs

```bash

npm run docs:build

```

## Folder Structure

```

docs/

├── .vitepress/

│   ├── config.js

│   └── theme/

│       ├── index.js

│       └── custom.css

├── public/

│   ├── logo.png

│   └── logo-big.svg

├── about.md

├── configs.md

├── contact.md

├── get-started.md

├── guide.md

├── index.md

├── package.json

└── README.md

```