Git Product home page Git Product logo

members's Introduction

Stories in Ready Build Status

members.codefordenver.com

Node.js application that connects volunteers with volunteers/projects based on their skill sets.


Requirements

  • Node.js - version 8.9.3 (if you have nvm type nvm use in the repo to use the correct version)

Setup:

  1. clone repo

  2. cd into repo directory

  3. Run npm install

    You may also want to install a prettier plugin for your editor. Check here for setup instructions

  4. Follow the following instructions to set up Auth0 and the API Explorer:

    1. Visit https://auth0.com/ and create a new Auth0 account or log-in to your existing one

      it will ask you for a tenant domain. Here you can just enter in your username as this will be used for the API endpoints of your clients.

      1. Select API from the side menu
      2. Select Auth0 Management API
      3. Select the API Explorer tab
      4. Select CREATE & AUTHORIZE A TEST CLIENT. This creates a client that can use the Management API.
      5. Select Applications from the side menu
      6. Select API Explorer Application
  5. Go the the command line and run npm run setup (You will be asked for the Domain, Client ID, and Client Secret from the API Explorer Client. Paste them into the command line). This will create the .env.local file in the root of the project.

  6. run npm run gc -- deploy

  7. Enter in the following information in your terminal: graphcool deploy info graphcool deply target name graphcool deploy service name

  8. If prompted to authenticate, enter in the Auth URL into your browser

  9. Sign up for Graphcool

  10. from the output from the previous command copy the Simple API url and add it to the .env.local file for variable REACT_APP_GRAPHCOOL_API

  11. run npm start

Quick Start

After you've followed the set up steps listed above, you can subsequently start the app with:

npm start

Debugging

General

Start your app by running npm start, and start debugging in VS Code by pressing F5 or by clicking the green debug icon with Chrome as the selected configuration. You can now write code, set breakpoints, make changes to the code, and debug your newly modified code—all from your editor.

Tests

Start debugging in VS Code by pressing F5 or by clicking the green debug icon with Debug CRA Tests as the selected configuration. You can now write tests, set breakpoints, make changes to the tests, and debug your newly modified tests—all from your editor.

Graphcool

The Graphcool framework is used to spin up and manage the backend for this project.

  1. Use locally installed version of framework with environment variable from .env.local
  • npm run gc -- <command>
  1. View list of available commands
  • npm run gc -- help
  1. Deploying the backend changes
  • npm run gc -- deploy
  1. Interactive console to test out GraphQL
  • npm run gc -- playground

Additional Information

Linting

This project employs the ESLint plugin eslint-plugin-graphql to help developers write schema-compliant GraphQL queries. This plugin will red-line invalid queries that are not schema compliant if you are using an editor with an installed ESLint plugin. If a query fails validation and hence the lint, the travis build will fail as well.

The schema file is checked in to the root directory of the repository as full-schema.json. If the schema on Graphcool is updated and full-schema.json is out of date. It is necessary to run the download-schema NPM script in order to update linting information.

Material-UI

This project uses Material-UI for theming. Be sure to check out their component demos, like this one for avatars.

Create React App

The front end for this project was bootstrapped with Create React App. Here are some generated docs from this project for helpful tips on how to do common things.

members's People

Contributors

2kiq avatar aziobrow avatar dchao19 avatar debugsteven avatar dviramontes avatar eemshi avatar eosem avatar evanplaice avatar feldbot avatar fredmon3 avatar jberns avatar jksmall0631 avatar justinkimtang avatar marshallhouston avatar mugwump303 avatar nlkluth avatar renniesb avatar sungbae avatar w0de avatar waffle-iron avatar wdoug avatar

Watchers

 avatar  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.