Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 3.48 KB

README.md

File metadata and controls

72 lines (44 loc) · 3.48 KB
Raw

Contributors Forks Stargazers Issues

Welcome! 👋🏼

First Issues is an initiative to curate easy pickings from open-source projects, so developers who've never contributed to open-source can get started quickly.

Open-source maintainers are always looking to get more people involved, but new developers generally think it's challenging to become a contributor. We believe getting developers to fix super-easy issues removes the barrier for future contributions. This is why First Issue exists.

Adding a new project

You're welcome to add a new project in FirstIssues.dev, and we encourage all projects — old and new, big and small.

Follow these simple steps:

  • Our goal is to narrow down projects for new open-source contributors. To maintain the quality of projects in First Issue, please make sure your GitHub repository meets the following criteria:

    • It has at least three issues with the good first issue label. This label is already present on all repositories by default. If not, you can follow the steps here.

    • It has at least 10 contributors.

    • It contains a README.md with detailed setup instructions for the project, and a CONTRIBUTING.md with guidelines for new contributors.

    • It is actively maintained.

  • Add your repository's path (in lexicographic order) in data/repos.json.

  • Create a new pull-request. Please add the link to the issues page of the repository in the PR description. Once the pull request is merged, the changes will be live on firstissues.dev.

Setting up the project locally

FirstIssues is built using NextJs.

To contribute new features and changes to the website, you would want to run the app locally. Please follow these steps:

  1. Clone the project locally. Make sure you have Python 3 and a recent version of Node.js installed on your computer.

  2. Add GITHUB_TOKEN, MONGODB_URI in .env file (refer .env.local for reference)

  3. Build the front-end app and start the development server.

$ npm install # install the dependencies
$ npm run dev # start the development server

The app should spin up on your browser.

Seeding

After completing the above steps, your app will be up and running. But, your database is empty. It needs to be populated.

GET http://localhost:3000/api/cron

Run this endpoint from Postman app / Browser. It will take some time. This will populate your DB with essential data to get started.