Backend part for issues-explorer project. This project aims to make it easier to discover opensource project issues which are suitable for beginners.
Frontend part of the project can be found here.
Project was created to support improving of technical and collaboration skills of Women Who Code members by developing an open-source web-application together during our hack events. With this, we want to provide learning playground for Hack Evening participants who are interested in chosen technology stack.
Programming language chosen for this project is java (based on interest of Hack Evening members).
We are building REST API using spring boot in order to quickly create standalone java Spring application without lots of configuration overhead. Our API will be serving data (about opensource projects of interest) saved in PostgreSQL database.
Anyone who already has experience with these technologies or would like to gain it from scratch is welcome to join the project!
In order to develop and contribute to this project one needs to have github account set. If you don't have one, follow instructions and create it.
If you are new to using version control it would be good that you get familiar with it, particularly with git, prior to moving forward. To learn and practice basic git commands you will need, you can follow this interactive tutorial.
Information how to setup your development environment can be found here.
After successfully setting up your environment, navigate to your project directory in terminal and run
gradle test
to run all tests in the project.
There are a lot of opensource projects whose contributors apart from wanting to get new contributors, also want to support people to step into opensource community by providing clean guidelines on how to contribute, insisting on precise issue descriptions and labeling issues suitable for beginners by one of the following labels: first-timers-only, up-for-grabs, newcomer, jump-in etc.
issues-explorer project aims to display up to date overview of those issues allowing for filtering/grouping by programming language or other repository tags.
In the next phase project should also be able to display info how much activity is happening in each repository and option to sort by most/least active ones.
Data about github repositories of opensource projects and currently open issues of our interest (issues which are good for beginners) should be fetched from github through github REST api and stored in relational database.
Link to GitHub API: https://developer.github.com/v3/
Our application (REST api) should serve information about those beginner friendly issues and our frontend project should use our API.
Currently, there is only a skeleton for REST API (dummy /index endpoint) created using spring boot.
List of tasks to be tackled next is in issues section.
There is a newcomer label attached when issue is good for beginners.
Please review our contributing guidelines and enjoy collaboration!
Please feel free to address any further questions you have about the project either at the next Hack Evening or via email: berlinhacknights@womenwhocode.com
We are also welcoming any suggestions/ideas you might have about project, process of development, technology stack or how to make project onboarding easier and clearer.