From e5366f5b92b894f53c159f00b2c983a3d6a253c8 Mon Sep 17 00:00:00 2001 From: harshit-2705 Date: Sat, 4 Oct 2025 00:10:58 +0530 Subject: [PATCH 1/2] docs: improve welcome message in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 028fcba4..389e713b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@

-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. From 88b82ec55798441cccccc9d95492f56c011da3b7 Mon Sep 17 00:00:00 2001 From: harshit-2705 Date: Sat, 4 Oct 2025 00:17:53 +0530 Subject: [PATCH 2/2] docs: add quick start instructions to run project locally --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 389e713b..f4b09940 100644 --- a/README.md +++ b/README.md @@ -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: