👤 Collins Muriuki

• Twitter: @collinsmuriuki_
• Github: @collinsmuriuki

gitconnect is an app that allows a user to search for GitHub users and display their profile information as well as a glimpse of their repositories.

Here are the features in summary:

• A minimalistic landing page with a button that navigates user to the search page.
• A search page which allows the user to search for github users by typing in their usernames.
• A minimalistic display of the github user information and their repositories ordered alphabetically

• To run this app on your text editor, you will need the following:
  • Node: for installation instructions follow this link
  • Angular CLI version 8.0.3: installation of Angular is described here
  • A github developer API token, clientId and client secret, all these can be gotten after creating an application on github

To view the app, open the live site link provided below on the README. Here is a run through of how to set up the application:

• Step 1 : Clone this repository using git clone https://github.com/collinsmuriuki/gitconnect.git, or downloading a ZIP file of the code.
• Step 2 : The repository, if downloaded as a .zip file will need to be extracted to your preferred location and opened
• Step 3 : Open the terminal, go to the project directory and download the dependencies in the package.json using npm install
• Step 4 : On the root of the src directory, create an environments directory; inside, create two files, environment.ts and environment.prod.ts
  • In environments.ts copy this code:

        export const environment = {
        production: false,
        token: 'YOUR_TOKEN',
        clientId: 'YOUR_CLIENTID',
        clientSecret: 'YOUR_CLIENTSECRET',
        };

  • And finally in environment.prod.ts, copy the above code but change production key from false to true
• Step 5 : Run ng serve on the terminal for a dev server. Navigate to http://localhost:4200/. The app will automatically reload if you change any of the source files

• Error messeage on typing in a username that cannot be found, is inconsistent.

• Angular CLI version 8.3.6.
• HTML
• CSS
• Javascript
• Bootstrap 4.3.1
• font-awesome

You can provide feedback or raise any issues/ bugs through the following means:

• [email protected]

You can view the live application by following this link.

Give a ⭐️ if this project helped you!

Copyright © 2019 Collins Muriuki.
This project is MIT license licensed.