Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thecreazy/siteaudit
Site audit for your site from terminal
https://github.com/thecreazy/siteaudit
hacktoberfest hacktoberfest2021
Last synced: 12 days ago
JSON representation
Site audit for your site from terminal
- Host: GitHub
- URL: https://github.com/thecreazy/siteaudit
- Owner: thecreazy
- License: mit
- Created: 2018-10-22T12:29:59.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T23:02:10.000Z (almost 2 years ago)
- Last Synced: 2024-09-22T10:35:08.404Z (about 2 months ago)
- Topics: hacktoberfest, hacktoberfest2021
- Language: JavaScript
- Homepage:
- Size: 7.11 MB
- Stars: 397
- Watchers: 7
- Forks: 15
- Open Issues: 8
-
Metadata Files:
- Readme: README.MD
- Changelog: CHANGELOG.md
- License: LICENSE.MD
Awesome Lists containing this project
README
# 📈 Siteaudit: Generate audit benchmark for your site 📈
Siteaudit will analyze your site and generate audit for:
- Pagespeed
- Lighthouse
- A11y
## Installation
### **Use nodejs**
You can use `siteaudit` from your terminal using the npm package and run it as a binary
```sh
npm -g i siteaudit
siteaudit --url https://canellariccardo.it
```
or you can use siteadit inside your node application
```js
const SiteAudit = require('siteaudit/lib/node');
SiteAudit.start('https://canellariccardo.it', {
pagespeed: true,
lighthouse: false,
a11y: true,
outputFolder: '/output',
customAppenName: `-${Date.now()}`,
});
```
### **Use docker**
You can also use the docker image to generate the reports
#### Passing no configuration
```sh
docker run -t \
-v "$(pwd)/.testoutput":"/app/output" \
thecreazy/siteaudit:latest \
--url https://canellariccardo.it \
--headless
```
#### Passing configuration
```sh
docker run -t \
-v "$(pwd)/.testoutput":"/app/output" \
-v "$(pwd)/.siteaudit.json":"/.siteaudit.json"
thecreazy/siteaudit:latest \
--url https://canellariccardo.it \
--no-lighthouse \
--config /.siteaudit.json \
--headless
```
## Runtime options
- `--url` specify the base url to test
- `--output` specify the output directory (where your assets will be generated)
- `--config` specify a JSON file containing an extension to the configuration
- `--no-pagespeed` no pagespeed audit will be generated
- `--no-lighthouse` no lighthouse audit will be generated
- `--no-a11y` start without a11y audit
- `--headless` use chrome headless
## Using ENV
You can also use environments for passing the options
- `SITEAUDIT_NOLIGHTHOUSE` no lighthouse audit will be generated
- `SITEAUDIT_NOPAGESPEED` no pagespeed audit will be generated
- `SITEAUDIT_CONFIG` specify a JSON file containing an extension to the configuration
- `SITEAUDIT_URL` pass the url for running the audit
- `SITEAUDIT_A11Y` no a11y audit will be generated
- `SITEAUDIT_HEADLESS` use chrome headless
- `SITEAUDIT_USINGENV` force the use of the environments
## Configuration
If you pass to `siteaudit` an additional JSON file, it will be merged with initial config.
```sh
siteaudit --url https://canellariccardo.it --config ./config.json
```
Example:
```json
{
"pagespeed": {
"pages": ["/", "/404"]
}
}
```
### config.son
You can also pass a custom config json, there are some examples:
- pagespeed
```js
{
"pagespeed":{
"strategy" : [ "mobile", "desktop"], // Strategy to use when analyzing the page. this is the base settings, you can only use mobile | desktop
"locale": "en_US", // Locale results should be generated in.
"threshold": "70", // Threshold score to pass the PageSpeed test. Useful for setting a performance budget.
"pages": ["/"]. //Array of relative pages to analyze, default is only / (please, use relative path)
}
}
```
- lighthouse
> For full list of settings options see [here](https://github.com/GoogleChrome/lighthouse/blob/master/docs/configuration.md).
```js
{
"lighthouse":{
"extends" : [ "lighthouse:default" ], // (string|boolean|undefined) The extends property controls if your configuration should inherit from the default Lighthouse configuration.
"settings": {
"onlyCategories": ["performance"],
"onlyAudits": ["works-offline"],
}, // (Object|undefined) The settings property controls various aspects of running Lighthouse such as CPU/network throttling and audit whitelisting/blacklisting.
"audits": [
"first-meaningful-paint",
"first-interactive",
"byte-efficiency/uses-optimized-images",
] // (string[]) The audits property controls which audits to run and include with your Lighthouse report.
}
}
```
## Using in gitlab-ci
You can also use `siteaudit` in your gitlabci.yml
```yml
stages:
- audit
audit:
image:
name: thecreazy/siteaudit:latest
entrypoint: ['']
stage: audit
variables:
SITEAUDIT_URL: 'https://canellaricardo.it'
script:
- echo "started siteaudit"
- /usr/local/bin/siteaudit --url=${SITEAUDIT_URL} --headless
artifacts:
paths:
- output
```
## Output
`siteaudit` will generate this output:
- `lighthouse-audit.html`: contains the classic html result of lighthouse
- `pagespeed-audit.md`: a markdown format result of the pagespeed api
- `a11y-audit.md`: a markdown format result of the a11y api
### Output examples
## Contributing
#### **Reporting bugs**
- Open a GitHub issue
#### **Contributing with patches and bug fixes**
- Open a new GitHub pull request with the patch.
- Ensure the PR description clearly describes the problem and solution.
## Contributors
- Riccardo Canella [@thecreazy](https://github.com/thecreazy)
## License
MIT