README.md

GitHub Explorer

I spent couple evenings learning VueJS and decided to put my skills to a test. This project allows you to browse GitHub and bookmarks repos and share them via e-mail.

Before You Start

Before you start, it is highly recommended to set up a personal GitHub OAuth2 access token, so that GitHub does not rate limit HTTPS requests. Copy and paste your GitHub access token to ./secrets.json. Without access token, requests might fail and the app might not work as expected!

Detailed Information

For more background infos about this project, please check the wiki.

Getting Started

npm install

Running Client and Server

npm run start             # check your browser at http://localhost:8080

Compiles and minifies for production

npm run build

Run your unit tests

npm run test:unit         # runs Jest

Run your end-to-end tests

npm run test:e2e          # runs E2E Cypress tests in the GUI
npm run test:e2e:headless # runs E2E tests in command line

Lints and fixes files

npm run lint              # uses ESLint with the AirBnB style guide

Customize configuration

See Configuration Reference.