Merge pull request #220 from CodeForPhilly/clean-up-js-dependencies

Clean up JS dependencies

Author: marcelkooi

.gitignore

@@ -95,8 +95,9 @@ db.sqlite3
 /.cache
 /dist
 
-# dependencies
+# Javascript
 frontend/node_modules/
+node_modules
 frontend/.pnp
 .pnp.js
 
@@ -116,4 +117,4 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
-/notes.txt
+/notes.txt

README.md

@@ -8,9 +8,9 @@ Currently, they are storing data from their programs in separate Excel spreadshe
 
 This project would work to migrate all of the disparate data sources into one system, make a UI that allows Prevention Point to access all participant data in one system, and increase the ease with which program coordinators can evaluate and monitor activities.
 
-## Before Contributing: 
+## Before Contributing:
 
-* Read through the [Wiki](https://github.com/CodeForPhilly/prevention-point/wiki). 
+* Read through the [Wiki](https://github.com/CodeForPhilly/prevention-point/wiki).
 * Familiarize yourself with the agreed upon project [change management practices](https://github.com/CodeForPhilly/prevention-point/wiki/Change-Management-Practices).
 
 ## [Code of Conduct](https://codeforphilly.org/pages/code_of_conduct/)
@@ -66,6 +66,8 @@ $ docker-compose down
  - Run `yarn` to install dependencies
  - Run `yarn dev` and navigate to `localhost:1234`
 
+ For more information on the front-end please see the [front-end README](./frontend/readme)
+
 Other tools
 ## Links
 [Wiki](https://github.com/CodeForPhilly/prevention-point/wiki)

frontend/README.md

@@ -1,21 +1,26 @@
 # Prevention Point URS Frontend
+
 The frontend app for the Prevention Point Unified Reporting System (URS) project.
 
 ## Project Frameworks and Tools
- - Main Framework: [React](https://reactjs.org/)
- - UI Framework: [Material UI](https://material-ui.com/)
- - Styling: [Sass](https://sass-lang.com/)
- - Bundler: [Parcel](https://parceljs.org/)
- - Package manager: [Yarn](https://yarnpkg.com/)
+
+- Main Framework: [React](https://reactjs.org/)
+- UI Framework: [Material UI](https://material-ui.com/)
+- Styling: [Sass](https://sass-lang.com/)
+- Bundler: [Parcel](https://parceljs.org/)
+- Package manager: [Yarn](https://yarnpkg.com/)
 
 ## Project Style Conventions:
+
 ### Javascript
+
 - Javascript styling / formatting is enforced by [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/)
   - configure ESLint settings in .eslintrc.json
   - configure Prettier settings in .prettierrc.json
 - The project uses [Husky](https://github.com/typicode/husky) to run a precommit hook to lint files before they are commited. If there are any files ESlint and/or Prettier can't fix automatically, they'll fail to commit and an error log will be displayed
 
 ### SCSS
+
 - When possible, try to rely onn Material UI component APIs for styling
 - SCSS styling enforced by [stylelint](https://stylelint.io/)
-- When writing SCSS, try to adhear to [BEM conventions](http://getbem.com/)
+- When writing SCSS, try to adhere to [BEM conventions](http://getbem.com/)