https://github.com/foo-software/foo-api
Projects for Foo's API
https://github.com/foo-software/foo-api
Last synced: 9 months ago
JSON representation
Projects for Foo's API
- Host: GitHub
- URL: https://github.com/foo-software/foo-api
- Owner: foo-software
- Created: 2021-05-02T19:18:07.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-07-16T16:00:45.000Z (over 2 years ago)
- Last Synced: 2025-04-15T10:05:43.595Z (10 months ago)
- Language: TypeScript
- Size: 3.59 MB
- Stars: 4
- Watchers: 1
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Foo API
[Foo (www.foo.software)](https://www.foo.software) provides website quality monitoring with tools such as Lighthouse. Foo can be used to establish historical records of Lighthouse audits to analyze website performance, SEO, accessibility and best practice. Monitoring website Lighthouse scores can be useful for maintainers to have insight when changes occur. Foo provides a means to manage Lighthouse audits of pages defined in its web UI. Foo also provides a [REST API](./endpoints.md) and a corresponding [Node.js API client](./api-client.md) to manage pages and Lighthouse audits programmatically which is what this project is all about!
This is a monorepo providing NPM packages for Foo's public API and documentation related to it.
## Packages
- [`@foo-software/foo-api-client`](packages/foo-api-client): An API client to communicate with Foo's REST API endpoints. Find it [on NPM](https://www.npmjs.com/package/@foo-software/foo-api-client).
- [`@foo-software/foo-api-cli`](packages/foo-api-cli): A CLI to communicate with Foo's REST API endpoints. Find it [on NPM](https://www.npmjs.com/package/@foo-software/foo-api-cli).
## Documentation
- [Getting started with Foo and the API](https://www.foo.software/docs)
- [API: Resources](https://www.foo.software/docs/api/resources)
- [API: Endpoints](https://www.foo.software/docs/api/endpoints)
- [Node.js API client](https://www.foo.software/docs/api-client)
- [CLI](https://www.foo.software/docs/api-cli)
## Credits
> 
This package was brought to you by [Foo - a website quality monitoring tool](https://www.foo.software). Automatically test and monitor website performance, SEO and accessibility with Lighthouse. Analyze historical records of Lighthouse tests with automated monitoring. Report with confidence about SEO and performance improvements to stay on top of changes when they happen!