Open Source Ranker

Website for ranking open source projects
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. License
5. Contact

About The Project

• Shows open source repositories with a rating from A to Z (best to worst) based on how easy it is to contribute.
• Gives detailed information about repositories such as number of open issues, forks, stars, author, etc.

(back to top)

Built With

• React.js
• Chart.js
• React Toastify
• Octokit.js
• IsGithubUrl
• Styled Components

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

To start you need to do the following installations

• Node JS

  sudo apt install nodejs

• npm

  npm install npm@latest -g

(back to top)

Installation

1. Clone the repo

   git clone https://github.com/S4ND1X/OpenSourceRanker.git

2. Install NPM packages

   npm install

3. Enter your Github Developer Token in a new .env file

   REACT_APP_GITHUB_API_KEY= 'ENTER YOUR TOKEN';

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Jorge Sanchez- @S4ND1X

Sebastián Crossa - @sebastiancrossa

Marlene Harms - @marleneharms

Project Link: https://github.com/S4ND1X/OpenSourceRanker

(back to top)