An open API service indexing awesome lists of open source software.

https://github.com/oslabs-beta/vantage

Next.js development tool to track site performance metrics. Built with Google Lighthouse.
https://github.com/oslabs-beta/vantage

lighthouse nextjs seo

Last synced: 5 months ago
JSON representation

Next.js development tool to track site performance metrics. Built with Google Lighthouse.

Awesome Lists containing this project

README

          

# Vantage Logo

# [VANTAGE]("https://www.vantagenext.com")

[![Build](https://img.shields.io/github/workflow/status/oslabs-beta/Vantage/Node.js%20CI)](https://github.com/oslabs-beta/Vantage/)
[![NPM Downloads](https://img.shields.io/npm/dm/vantage-next)](https://www.npmjs.com/package/vantage-next)
[![Issues](https://img.shields.io/github/issues/oslabs-beta/Vantage)](https://github.com/oslabs-beta/Vantage/issues)
[![License](https://img.shields.io/github/license/oslabs-beta/Vantage)](https://github.com/oslabs-beta/Vantage/)

Vantage is a web optimization tool designed for NEXTjs apps.

- Uses Google lighthouse under the hood to determine key web vital scores and improvement suggestions.
- Evaluates your app in the background with every commit.
- Automatically evaluates every page in the app by traversing the project's endpoints to capture data.
- Allows you to compare snapshots to see exactly which recommendations changed, and how your updates have directly influenced specific metrics.

## Get Started

Install as a dev dependency in your project to get started.

```
npm install vantage-next --save-dev
```

## Documentation

View further documentation, config setup, and troubleshooting guides at:

https://www.vantagenext.com/docs

### Vantage Dashboard

![Vantage Dashboard](https://github.com/oslabs-beta/vantage-splash/blob/dev/public/splash/dashboard-view.png?raw=true)

### Compare Commit Results:

Compare Commits

### Choose Endpoints:

Choose Endpoints

## Technologies used

- Google Lighthouse
- Reactjs
- Material UI
- Redux Toolkit
- Recharts
- SASS
- Webpack
- Puppeteer
- Node

## Contributors

- Ari Shoham - [Github](https://github.com/arishoham) | [LinkedIn](https://www.linkedin.com/in/ari-shoham/)
- Michael Noah - [Github](https://github.com/mnoah1) | [LinkedIn](https://www.linkedin.com/in/mnoah/)
- Eli Davis - [Github](https://github.com/elidavis42) | [LinkedIn](https://www.linkedin.com/in/elidavis42/)
- Paul Perez - [Github](https://github.com/perezp92) | [LinkedIn](https://www.linkedin.com/in/perezp92/)

## Want to Contribute?

1. Clone the repo and make a new branch: `$ git checkout https://github.com/oslabs-beta/Vantage.git -b [name_of_new_branch]`.
1. Add a feature, fix a bug, or refactor some code :)
- Make sure to lint your code!
1. Write/update tests for the changes you made, if necessary.
1. Run unit & integration tests and make sure all tests pass: `npm test`.
1. Open a Pull Request with a comprehensive description of changes to the `dev` branch.
1. Open a Pull Request to the [docs](https://github.com/oslabs-beta/vantage-splash) and _Contributors_ if necessary.

**Thank you!**