https://github.com/frocher/botnbot
Main repository for the Botnbot application.
https://github.com/frocher/botnbot
lighthouse lit-element monitoring performance
Last synced: 7 months ago
JSON representation
Main repository for the Botnbot application.
- Host: GitHub
- URL: https://github.com/frocher/botnbot
- Owner: frocher
- License: apache-2.0
- Created: 2019-08-06T13:44:58.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-24T12:50:01.000Z (over 2 years ago)
- Last Synced: 2025-02-28T03:22:34.715Z (7 months ago)
- Topics: lighthouse, lit-element, monitoring, performance
- Language: JavaScript
- Homepage:
- Size: 2.42 MB
- Stars: 35
- Watchers: 2
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome to Botnbot
> Botnbot is an uptime and front-end performance monitoring tool.
The Botnbot application is divided in 3 components :
* [The front end](frontend/README.md) : the Single Page Application written with [LitElement](https://lit.dev/) webcomponents.
* [The backend](backend/README.md) : the API and the core of the application.
* [The probes](probe/README.md) : you can use as many probes as you want to measure your pages performance.
## Quickstart guide
For an easy quickstart, you must have Docker and [docker-compose](https://docs.docker.com/compose/) installed on your computer.
To start the application for the first time you just have to enter these 3 lines in your terminal :
```sh
docker-compose build
docker-compose run api rake db:migrate
docker-compose up
```
Once launched, you can create a new account:
1. Enter the url http://localhost:8080 in your browser.
2. Click the [signup](http://localhost:8080/signup) link.
3. Enter your account informations and click the "SIGN ME UP" button.
4. Enter the url http://localhost:8082 in your browser to open the maildev web client, and follow the instructions of the signup mail.
5. You can now sign in the application with your new account.
### Environment variables
Each component uses environment variables for configuration. Default values are defined directly in the *docker-compose.yml* file. You can replace them with your own values by creating a [env](https://docs.docker.com/compose/env-file/) in the directory where the *docker-compose* command is executed.
## License
This project is [Apache License 2.0](https://github.com/frocher/botnbot/blob/master/LICENSE) licensed.