Lighthouse

A Lighthouse Slack integration for everyone.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

A Slack integration for Lighthouse – an open-source, automated tool for improving the quality of web pages.

Lighthouse helps identify and fix common problems that affect your site's performance, accessibility, and user experience. Learn more about it here.

With our bot, you can choose to run the full report, or select the specific audits you'd like to run. Information on all the audits can be found here.

Built With

• Bolt
• Ngrok
• Nodemon
• AWS SDK
• Lighthouse

Getting Started

To get a local copy up and running follow these steps.

Prerequisites

In your local environment, you need:

• Node.js (comes with npm)
• nodemon

npm i nodemon

• ngrok

Installation

1. Get a free API Key at https://example.com
2. Fork and clone your forked repo

git clone https://github.com/your_username_/lighthouse-bolt.git

3. Install NPM packages

npm install

4. Enter your API in config.js

const API_KEY = 'ENTER YOUR API';

Usage

1. Run the app locally

npm start

2. Run ngrok to host Slack bot

ngrok http 3000

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the Apache 2.0 License. See LICENSE for more information.

Contact

Eivenlour David

Helen Gezahegn

Winnie Ren

Acknowledgements

• Img Shields
• GitHub Pages