Description

This project is a Github repositories clone with search functionality. The project uses THE GITHUB API.

This application was deployed to heroku https://github-repositories-clone.herokuapp.com/

How to run

Clone the project from github to your local machine using :

git clone https://github.com/mohamedbenattia99/Github-repositories-clone.git

Then, you have to enter to the project directory on your local machine and install dependencies using :

npm install

Finally, you have to start the server :

npm start

Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

Run with Docker

Docker Compose is really useful when we don’t have the development environment setup on our local machine to run all parts of the application to test. To run the application use :

docker-compose up

Test

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

Future Improvements

As future improvements, we can :

  • Create a single page for each repository
  • Adding user profile page
  • Filtering repositories by stars

Feedback

  • During the project I got to discover for the first time the Github API.
  • First time using react router dom v6 with its new functionalities