Skip to content

Latest commit

 

History

History
30 lines (18 loc) · 1.03 KB

README.md

File metadata and controls

30 lines (18 loc) · 1.03 KB

GitHub Trending Repositories

A simple next.js web app that displays trending repositories from GitHub over the last 7 days. It also gives users the option to favourite any repositories, this is stored in localstorage so will remain until the user clears their storage.

Getting started

To run the development environment do the following:

  • Ensure you are using node LTS
  • Open the directory in your preferred terminal
  • Run yarn or npm i
  • Run yarn dev or npm run dev

To build and serve the project do the following:

  • Ensure you are using node LTS
  • Open the directory in your preferred terminal
  • Run yarn or npm i
  • Run yarn build or npm run build
  • Run yarn start or npm run start

Testing

Tests are crested using jest and react-testing-library in order to run all tests use command yarn test or npm run test

Deployment

This web application is deployed using vercel, you can see the latest deployed version here: trending-repositories.vercel.app.