Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/furqanramzan/clean-code-guidelines
🚀 A comprehensive documentation project A that provides practical advice and best practices for writing clean and maintainable code
https://github.com/furqanramzan/clean-code-guidelines
best-practices clean-code code-guide code-organization code-quality design-patterns documentation functions maintainability naming-conventions principles readability variables
Last synced: 6 days ago
JSON representation
🚀 A comprehensive documentation project A that provides practical advice and best practices for writing clean and maintainable code
- Host: GitHub
- URL: https://github.com/furqanramzan/clean-code-guidelines
- Owner: furqanramzan
- Created: 2023-03-24T21:58:25.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-11T09:17:35.000Z (over 1 year ago)
- Last Synced: 2024-11-25T11:42:33.605Z (2 months ago)
- Topics: best-practices, clean-code, code-guide, code-organization, code-quality, design-patterns, documentation, functions, maintainability, naming-conventions, principles, readability, variables
- Language: TypeScript
- Homepage: https://furqanramzan.github.io/clean-code-guidelines
- Size: 4.76 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Clean Code Guidelines - [Live Demo](https://furqanramzan.github.io/clean-code-guidelines)
Look at the [VuePress Theme Hope](https://theme-hope.vuejs.press/) to learn more.
## Setup
Make sure to install the dependencies:
```bash
# pnpm
pnpm install
```## Development Server
Start the development server on http://localhost:8080
```bash
npm run dev
```## Production
Build the production application:
```bash
npm run build
```Check out the [deployment documentation](https://vuepress.vuejs.org/guide/deploy.html) for more information.