Skip to content

docs: improve welcome message in README #2430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

docs: improve welcome message in README #2430

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5366f5
docs: improve welcome message in README
harshit-2705 Oct 3, 2025
88b82ec
docs: add quick start instructions to run project locally
harshit-2705 Oct 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
</p>
<hr>

Welcome! 👋🏼
Welcome to Good First Issue! 👋🏼

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

Expand Down Expand Up @@ -33,6 +33,19 @@ Follow these simple steps:

## Setting up the project locally

### Quick Start

1. Make sure you have Python 3 and Node.js installed.
2. Copy the sample data files:
$ cp data/generated.sample.json data/generated.json
$ cp data/tags.sample.json data/tags.json
3. Install dependencies and start the dev server:
$ bun install
$ bun dev

This helps new contributors quickly run the app locally.


Good First Issue has two components — the front-end app built with Nuxt.js and a data population script written in Python.

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