Skip to content
Open
Changes from all commits
Commits
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
62 changes: 52 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,60 @@
# Good First Issues

> :warning: This repo is undergoing some transformation at the moment. Please be patient!
> ⚠️ This repo is currently being improved. Thanks for your patience and support!

Good First Issues empowers first-time contributors of open-source software. This website is primarily targeted at developers who want to contribute to open source software but do not know where or how to start. By providing developers with filters, the website empowers them to browse and select issues/repositories based on programming languages that they are comfortable with. In addition, they can select the type of issues they want to work on.
Good First Issues empowers first-time contributors of open-source software.
This website is primarily targeted at developers who want to contribute to open source software but do not know where or how to start.

Website: <https://goodfirstissues.com>
By providing developers with filters, the website empowers them to browse and select issues/repositories based on programming languages they are comfortable with.
In addition, they can select the type of issues they want to work on.

## Dependencies
- _Bootstrap_ for theme and frontend components
🌐 Website: <https://goodfirstissues.com>

---

## 📛 Badges

![GitHub License](https://img.shields.io/github/license/iedr/goodfirstissues)
![GitHub last commit](https://img.shields.io/github/last-commit/iedr/goodfirstissues)
![GitHub stars](https://img.shields.io/github/stars/iedr/goodfirstissues?style=social)

---

## 🚀 Getting Started

To run this project locally:

```bash
# Clone your fork
git clone https://github.com/<your-username>/goodfirstissues.git

# Enter the project folder
cd goodfirstissues

# Run backend
go run backend/main.go
```

Then open `http://localhost:8080` in your browser.

---

## 📦 Dependencies
- _Bootstrap_ for theme and frontend components
- _Golang_ and _GitHub Workflow_ for periodically calling [GitHub GraphQL API](https://docs.github.com/en/graphql)

## Credits
---

## 🤝 Contributing

We welcome contributions from everyone! 🎉
Please check the [CONTRIBUTING.md](CONTRIBUTING.md) file for guidelines.

---

## 🙌 Credits

- Original Cover template from [Bootstrap](https://getbootstrap.com/docs/4.5/examples/cover/) by [@mdo](https://twitter.com/mdo)
- Icons made by [Smashicons](https://smashicons.com/), [Pixel perfect](https://www.flaticon.com/authors/pixel-perfect), [Freepik](https://www.flaticon.com/authors/freepik) and [iconixar](https://www.flaticon.com/authors/iconixar) from [Flaticon](https://www.flaticon.com/)
- Favicon made by [Freepik](https://www.flaticon.com/authors/freepik) and generated with [ realfavicongenerator.net](https://realfavicongenerator.net/)
- Github Corner by [Tim Holman](https://tholman.com/github-corners/)
- Original Cover template from [Bootstrap](https://getbootstrap.com/docs/4.5/examples/cover/) by [@mdo](https://twitter.com/mdo)
- Icons made by [Smashicons](https://smashicons.com/), [Pixel perfect](https://www.flaticon.com/authors/pixel-perfect), [Freepik](https://www.flaticon.com/authors/freepik) and [iconixar](https://www.flaticon.com/authors/iconixar) from [Flaticon](https://www.flaticon.com/)
- Favicon made by [Freepik](https://www.flaticon.com/authors/freepik) and generated with [realfavicongenerator.net](https://realfavicongenerator.net/)
- GitHub Corner by [Tim Holman](https://tholman.com/github-corners/)