https://github.com/codacy/styleguide
Codacy awesome styleguide
https://github.com/codacy/styleguide
Last synced: about 1 month ago
JSON representation
Codacy awesome styleguide
- Host: GitHub
- URL: https://github.com/codacy/styleguide
- Owner: codacy
- License: apache-2.0
- Created: 2019-07-05T19:23:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-27T04:08:34.000Z (over 2 years ago)
- Last Synced: 2025-12-25T18:25:36.560Z (3 months ago)
- Language: SCSS
- Homepage:
- Size: 8.26 MB
- Stars: 0
- Watchers: 11
- Forks: 0
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Codacy Styleguide
[](https://www.codacy.com/app/Codacy/styleguide?utm_source=github.com&utm_medium=referral&utm_content=codacy/styleguide&utm_campaign=Badge_Grade)
[](https://circleci.com/gh/codacy/styleguide)
[](https://npmjs.org/package/@codacy/stylesheets "View this project on npm")
This is the Codacy awesome styleguide repository.
It will include components, code snippets and how to use them.
## Use
### SBT
```scala
"org.webjars.npm" % "codacy__stylesheets" % ""
"org.webjars.npm" % "codacy__legacy-javascripts" % ""
```
### NPM
```json
"dependencies": {
// ...
"@codacy/stylesheets": "",
"@codacy/legacy-javascripts": "",
"@codacy/react-components": ""
}
```
### Website
- https://legacy.styleguide.dev.codacy.org
## Structure
- [.aws](./.aws) - Deployment scripts and configurations
- [components](./components) - Custom react components
- [legacy-javacripts](./legacy-javascripts) - Codacy legacy javascripts
- [stylesheets](./stylesheets) - Codacy stylesheets
- [website-legacy](./website-legacy) - Codacy styleguide legacy website
## Develop
### Install Dependencies
```sh
yarn
yarn bolt:install
```
### Legacy Website
```sh
# yarn start:website-legacy # Just rebuilds the website without updating on dependency changes
yarn start:website-legacy-and-dependencies
```
### React Components
```sh
yarn build:components
```
### Stylesheets
```sh
yarn build:stylesheets
```
### Legacy Javascripts
```sh
yarn build:legacy-javascripts
```
### Others
Check section `scripts` in [package.json](./package.json)
## What is Codacy
[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt,
helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.
### Among Codacy features
- Identify new Static Analysis issues
- Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
- Auto-comments on Commits and Pull Requests
- Integrations with Slack, Jira, YouTrack
- Track issues Code Style, Security, Error Proneness, Performance, Unused Code and other categories
Codacy also helps keep track of Code Coverage, Code Duplication, and Code Complexity.
Codacy supports PHP, Python, Ruby, Java, JavaScript, and Scala, among others.
### Free for Open Source
Codacy is free for Open Source projects.