Skip to content

JadivaM/Gitsearch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

229 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gitsearch

  • This project entailed communicating with the Github API making requests to search for users, save them to the database, when saving a user you will follow the saved user on Github, display all saved users on the users profile, and also unfollow the github user on github. To style various components React Bootstrap was used including the navigation bar and cards that render the user information and Sweet Alert to show success and error alerts.

Demo

gitsearch-demo-2021-09-25_01.15.01.mp4

How to use

  • You can sign up and log in with your name, email, and password.
  • If you have already registered your email on the app and try to sign up with the same email you will receive an error and will not be able to create another account.
  • You are able to see the password typed into the input and can verify that your password and confirm password match or you will receive an error and will not be able to create an account.
  • Once you are signed up you will receive a welcome email.
  • If you need to reset your password, you can click on forgot password link in the login page to be able to input your email and be sent an update password link.
  • Once logged in you can then navigate to the search page by clicking on the search text button in the navigation bar.
  • In the search page you are able to input a user's name on github and the results will be rendered on a card.
  • Once the result is rendered, you may click on the 'Save User' button to save the user to your profile and begin to follow the user on Github.
  • To navigate to the stored Github users, you can navigate back to your profile by clicking on the profile text button in the navigation bar.
  • You will then be able to see all of the saved users in your profile.
  • If you wish to unsave any users clicking on the 'Remove User' button will unsave the user from your profile and unfollow the user on Github.
  • You can also logout of your account to keep your information safe.

API information

Libraries

  • JWT to generate authorization tokens.
  • Bcrypt to hash user passwords.
  • Validator to validate data.
  • Passport for authenticating with a JSON Web Token.

Setup

  • git clone this repo
  • cd into it.
  • yarn install
  • cd client && yarn install
  • cp .env.sample .env

Available build commands

  • yarn dev: Runs BOTH your Express.JS and React developer environment locally at the same time. Any logs coming from Express will be prefaced with [0], any logs from create-react-app will be prefaced with [1].
  • yarn server: Runs JUST your Express.JS server.
  • yarn client: Runs JUST your front-end React app.

Open http://localhost:3000 to view your local React app in the browser. The page will reload if you make edits.

Postman testing

  • Endpoint testing has been saved to a collection.

Run in Postman

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors