Skip to content
No description, website, or topics provided.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper
out/production/resources
src
.gitignore
CONTRIBUTING.md
README.md
SETUP.md
build.gradle
cloud_ide_setup.pdf
gradlew
gradlew.bat
project_overview.png

README.md

berlin-issues-explorer-be

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.

Motivation for the project

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.

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!

Project setup

Set your github account

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.

Set your development environment

Information how to setup your development environment can be found here.

Run tests

After successfully setting up your environment, navigate to your project directory in terminal and run

gradle test

to run all tests in the project.

Project walk-through

Goal of 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.

project components

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 GraphQL api and stored in relational database.

Link to GitHub GraphQL API: https://developer.github.com/v4/

Bellow is an example of the query which is fetching data about issues. You can try it out at Github GraphQL API Explorer: https://developer.github.com/v4/explorer/

Place the query in the GraphiQL box:

query queryIssue($labelName: String!) {
 search( query:$labelName, type: ISSUE, last:100){
    edges{
      node{
        ... on Issue{
          id
          title
          url
          labels(last:100) {
            edges {
              node {
                name
              }
            }
          }
          repository {
            name
            url
            repositoryTopics(last:100) {
              edges {
                node{
                  topic {
                    name
                  }
                }
              }
            }
            languages(first:100) {
              edges {
                node {
                  name
                }
              }
            }
          }
        }
      }
    }
}
}

And variables in the QUERY VARIABLES box:

{"labelName" : "label:\"good first issue\""}

Our application (REST api) should serve information about those beginner friendly issues and our frontend project should use our API.

List of tasks to be tackled next is in issues section. There is a newcomer label attached when issue is good for beginners.

Contributing

Please review our contributing guidelines and enjoy collaboration!

Have some questions or suggestions?

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.

You can’t perform that action at this time.