README.md

server

An Apollo server application that provides GitHub data and authentication, by consuming data from Github GraphQL API.

Introduction

Over the last years, open source organizations have been struggling to identify, honor and profile their contributors. These efforts have the purpose not only of attracting new contributors, but also of being a part of the hiring process.

The solution: to provide open source organizations with a customizable platform from which they can better understand their contributors and give them appropriate recognition.

Requirements

Make sure you have Node.js and npm installed in your machine. If you're using Ubuntu, you can follow this tutorial.

Running the server

This section contains information about what you need to do to run this server locally.

First of all, you'll need to clone our repository by executing:

git clone https://github.com/panelinhadees/server
cd server

Inside /server, you'll need to install the dependencies used in this project, by executing:

npm install

Finally, you'll be able to run our application, by executing:

npm start

Now you can access our application locally and it's listening on http://localhost:5000.

You can access the endpoint http://localhost:5000/graphql to access graphql playground.

Docs

Some useful documentations you can use to learn about the tecnologies used on this server development:

• Github GraphQL API
• GraphQL
• How to up our server
• Understanding our github authentication flow