Repository files navigation

A web application to connect musicians with healthcare centers.

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

• EncoreLink Specification - this is our current spec

Developer documentation currently liveshere

1. InstallNode.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. Runnpm 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 theREACT_APP_GOOGLE_API_KEY environment variable
7. Runnpm start

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

This is anoptional 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. InstallPostgreSQL (for mac we'd recommend installinghttp://postgresapp.com/)
2. Create a new database in postgres (you can call itencorelink)
3. Copy theserver/datasources.local.example.json toserver/datasources.local.json and update the config forpostgres in that file to match the info for that postgres database (i.e. setting thehost,port,database,username, andpassword)

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

It ishighly recommended that you configure your editor to run eslint on the flywhile you code.

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

This project uses Facebook'sjest library for testing,and takes advantage of theirsnapshot testing.

For development run:

npmtest -- --watch

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

We run the app with a different configuration for local development than we dofor deploying. If things work when running locally, but fail when deploying,runnpm prune --production to set yournode_modules to match production andrunnpm run heroku to emulate the config used for production (visible onlocalhost:3000).

You might also want to make sure you have the same npm modules that will beinstalled on heroku (this can be done withrm -rf node_modules && npm install --production). In this case, you'll have to start the app withNODE_ENV=production npm start (or otherwise exportNODE_ENV=productionbefore starting).

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

TheChrome version of the plugin can be found here

We have integratedReact Storybook for development of React componentsin isolation independent of having to wire up data from the app.

To run react storybook, runnpm run storybookThis will start storybook running athttp://localhost:9001

Stories are defined for components inclient/stories/index.js.For docs on how to write stories see thestorybook docs.

• 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