Skip to content

docs: improve README with Project Overview, Table of Contents, prereq… #2438

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 1 commit into
base: master
Choose a base branch
from
Open

docs: improve README with Project Overview, Table of Contents, prereq… #2438

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,23 @@
</p>
<hr>

## Project Overview
Good First Issue helps beginners contribute to open-source by curating projects with easy-to-fix issues labeled `good first issue`.
The project has two main components:
- **Frontend:** Built with Vue.js using the Nuxt.js framework
- **Backend/Data script:** Written in Python

Welcome! 👋🏼

**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.

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 Good First Issue exists.

## Table of Contents
1. [Project Overview](#project-overview)
2. [Adding a New Project](#adding-a-new-project)
3. [Setting Up the Project Locally](#setting-up-the-project-locally)

## Adding a new project

You're welcome to add a new project in Good First Issue, and we encourage all projects &mdash; old and new, big and small.
Expand All @@ -35,10 +46,17 @@ Follow these simple steps:

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

### Prerequisites
- Python 3
- Node.js (latest version)

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.

```bash
git clone https://github.com/AyushMaurya3114/good-first-issue.git
cd good-first-issue
```
2. Make a copy of the sample data files for your local app to use and rename them to the filename that the app expects. **This step is important, as the front-end app won't work without these data files.**

```bash
Expand Down