Git Product home page Git Product logo

open-sauced's Introduction

CircleCI

Open Sauced

This is a GraphQL starter project to help people stalk open source repositories and take notes on them. This project uses Graphcool as a GraphQL backend, Apollo as the GraphQL client, and Netlify to deploy.

The data fetching from GitHub uses their GraphQL Early Access API exclusively.

open-sauced-screencap

Setup

1. GraphQL Backend

graphql-up

Setup your GraphQL backend using the graphql-up button at the top of this section. Once your backend is created in Graphcool, copy your GraphQL enpoint using the enpoints link.

endpoint

2. Retrieve GitHub Access Token

!Important: ๐Ÿ‘‰ To get access to the GitHub early access GraphQL API, fill out the prerelease agreement

You will need a GitHub access token to access the repository data fetching portion of this app. You can find instructions on how to retrieve one on GitHub.

token-example

Be sure to allow access to your user information when creating your token.

token-options

3. Deploy to Netlify

Deploy to Netlify

Click the deploy to Netlify button and add your GitHub access token and Graphcool Endpoint.

netlify-deploy

Graphcool Framework

Project Structure

The central configuration of your upgraded Service lives in the graphcool.yml. There, all your permissions, functions and types are tied together. You can find your schema in the types.graphql.

Deployment

To deploy changes of your service, just execute

$ graphcool deploy

Resources

CLI

You can read more about the CLI in the new docs Or execute graphcool to see the usage overview.

graphcool.yml

The graphcool.yml format is described here: https://docs-next.graph.cool/reference/service-definition/graphcool.yml-foatho8aip

Test

npm test

// to clean snapshots
npm run clean

Authentication

Authentication is handled through Netlify's Identity service. By default, user registration is open, meaning users can sign up using a form on your site. You can include the Netlify Identity widget in your site to handle this, or build your own form and integrate it using gotrue-js.

Service Worker

This project uses the sw-precache to kickstart an offline cache. The offline cache only registers in production. If service needs to be manually removed make an unregister call from the registerServiceWorker.js import.

Attribution

SVG Icons are from the open source Feather Icons project.

open-sauced's People

Contributors

bdougie avatar rolfea avatar drianhillman avatar michaeljclausen avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.