Skip to content

Latest commit

 

History

History
108 lines (75 loc) · 5.41 KB

README.md

File metadata and controls

108 lines (75 loc) · 5.41 KB
Raw

EncoreLink

A web application to connect musicians with healthcare centers.

Stories Ready to Work On Build Status

General Documentation

The documents we created when building EncoreLink are here. Probably the most helpful will be:

Developer Documentation

Developer documentation currently lives here

Getting Started

Basic Setup

  1. Install Node.js (The official node verion for this app is 6.11, although other modern versions will probably work fine)
  2. Clone this repo
  3. Navigate to your repo folder
  4. Run npm install
  5. Get a Google api key with the Google Maps Embed API and the Google Maps JavaScript API enabled (you can probably get this from one of the team members on the project)
  6. Copy .env.sample to .env and set the REACT_APP_GOOGLE_API_KEY environment variable
  7. Run npm start

If this doesn't open a browser for you, you can navigate to http://localhost:3000 to view the app. There is also an api explorer available at http://localhost:54321/explorer/

Advanced Setup - Postgres

This is an optional setup to run the app against postgres. This is good if you want to persist data or test how the app interacts with the actual database that we use in production, however, it can be a bit more complicated, so we don't recommend it generally.

  1. Install PostgreSQL (for mac we'd recommend installing http://postgresapp.com/)
  2. Create a new database in postgres (you can call it encorelink)
  3. Copy the server/datasources.local.example.json to server/datasources.local.json and update the config for postgres in that file to match the info for that postgres database (i.e. setting the host, port, database, username, and password)

Usage

Linting

This project uses eslint for checking coding practices and standards. It is expected that any opened pull requests have a passing eslint run.

It is highly recommended that you configure your editor to run eslint on the fly while you code.

Additionally, you can run eslint on the command line with npm run lint (or npm run lint -- --fix to have eslint attempt to fix some of the issues it finds)

Testing

This project uses Facebook's jest library for testing, and takes advantage of their snapshot testing.

For development run:

npm test -- --watch

This will run the tests in an interactive mode, where tests will automatically be re-run when files are changed, and snapshots can be updated on the fly.

Things work locally but not on Heroku...

We run the app with a different configuration for local development than we do for deploying. If things work when running locally, but fail when deploying, run npm prune --production to set your node_modules to match production and run npm run heroku to emulate the config used for production (visible on localhost:3000).

You might also want to make sure you have the same npm modules that will be installed on heroku (this can be done with rm -rf node_modules && npm install --production). In this case, you'll have to start the app with NODE_ENV=production npm start (or otherwise export NODE_ENV=production before starting).

Client App State

This project uses Redux for managing state on the client. There is a neat Redux DevTools browser extension that can help with understanding and debugging what is happening in the app as a user interacts with the client.

The Chrome version of the plugin can be found here

React Storybook

We have integrated React Storybook for development of React components in isolation independent of having to wire up data from the app.

To run react storybook, run npm run storybook This will start storybook running at http://localhost:9001

Stories are defined for components in client/stories/index.js. For docs on how to write stories see the storybook docs.

Built With

  • Node.js - Executes JavaScript code server-side
  • Loopback - Node.js API framework
  • Netlify - Frontend hosting; platform for automated deployment of static webpages
  • Heroku - Backend hosting; Cloud application platform for web application deployment
  • PostgreSQL - An object-relational database
  • React Storybook - Development environment for UI components
  • Redux - Manages state on the client