Node.js application that connects volunteers with volunteers/projects based on their skill sets.
- Node.js - version 8.4 (if you have nvm type
nvm use
in the repo to use the correct version)
Setup:
-
clone repo
-
cd into repo directory
-
Run
npm install
You may also want to install a prettier plugin for your editor. Check here for setup instructions
-
Follow the following instructions to set up Auth0 and the API Explorer:
- 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.
- Select
API
from the side menu - Select
Auth0 Management API
- Select the
API Explorer
tab - Select
CREATE & AUTHORIZE A TEST CLIENT
. This creates a client that can use the Management API. - Select
Clients
from the side menu - Select
API Explorer Client
- Select
- Visit https://auth0.com/ and create a new Auth0 account or log-in to your existing one
-
Go the the command line and run
npm run setup
(You will be asked for theDomain
,Client ID
, andClient Secret
from theAPI Explorer Client
. Paste them into the command line). This will create the.env.local
file in the root of the project. -
run
npm run gc -- deploy
-
Enter in the
Auth URL
into your browser -
Sign up for Graphcool
-
from the output from the previous command copy the
Simple API
url and add it to the.env.local
file for variableREACT_APP_GRAPHCOOL_API
-
run
npm start
After you've followed the set up steps listed above, you can subsequently start the app with:
npm start
The Graphcool framework is used to spin up and manage the backend for this project.
- Use locally installed version of framework with environment variable from
.env.local
npm run gc -- <command>
- View list of available commands
npm run gc -- help
- Deploying the backend changes
npm run gc -- deploy
- Interactive console to test out GraphQL
npm run gc -- playground
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.