ekowbaah / github-stats

Github Stats by Ekow Baah-Nyarkoh

This project was generated with Angular CLI version 14.0.0.

Libraries Used

This application makes use of the following third party libraries:

• @taiga-ui for already made angular components

• Tailwindcss as a css framework

• Swimlane charts for charts

Development server

Run ng serve for a dev server. By default the dev server runs on http://localhost:4200/ Navigate to http://localhost:4200/ if you don't specify another port . The application will automatically reload if you change any of the source files.

User guide

• On the sign in page, click on the 'Sign in with github' button to sign in via github. This will take you to another page where you can sign in with your github credentials.

• After sign in, you will be redirected to the app dashboard. In the selector on the top left of the page, you will see a list of your public repositories. Select a repository to see stats about that repository.

• In the commits list, click on the commit name to open the commit in github.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

Build

Run ng build to build the project. The build artifacts will be stored in the dist/ directory.

Running unit tests

Run ng test to execute the unit tests via Karma.

Running Cypress end-to-end tests

Run cypress:open to execute the end-to-end tests in cypress. Run cypress:run to execute the end-to-end tests in headless mode. Make sure you are running the dev server when running cypress tests. The default baseurl for cypress is http://localhost:4200/. In case you are running your application on another port, change the baseurl in the cypress config file.

Further help

For any questions about this application contact me through email