-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
huge overhaul to update create-react-app and M-UI
- Loading branch information
Showing
50 changed files
with
42,433 additions
and
17,978 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,31 @@ | ||
| --- | ||
| engines: | ||
| csslint: | ||
| enabled: true | ||
| duplication: | ||
| enabled: true | ||
| config: | ||
| languages: | ||
| - ruby | ||
| - javascript | ||
| - python | ||
| - php | ||
| eslint: | ||
| enabled: true | ||
| fixme: | ||
| enabled: true | ||
| ratings: | ||
| paths: | ||
| - "**.css" | ||
| - "**.inc" | ||
| - "**.js" | ||
| - "**.jsx" | ||
| - "**.module" | ||
| - "**.php" | ||
| - "**.py" | ||
| - "**.rb" | ||
| exclude_paths: | ||
| - "**/__tests__/**" | ||
| - "src/common/testData.js" | ||
| - "docs/**" | ||
| JavaScript: true | ||
| --- | ||
| engines: | ||
| csslint: | ||
| enabled: true | ||
| duplication: | ||
| enabled: true | ||
| config: | ||
| languages: | ||
| - ruby | ||
| - javascript | ||
| - python | ||
| - php | ||
| eslint: | ||
| enabled: true | ||
| fixme: | ||
| enabled: true | ||
| ratings: | ||
| paths: | ||
| - "**.css" | ||
| - "**.inc" | ||
| - "**.js" | ||
| - "**.jsx" | ||
| - "**.module" | ||
| - "**.php" | ||
| - "**.py" | ||
| - "**.rb" | ||
| exclude_paths: | ||
| - "**/__tests__/**" | ||
| - "src/common/testData.js" | ||
| - "docs/**" | ||
| JavaScript: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,2 @@ | ||
| --exclude-exts=.min.css | ||
| --ignore=adjoining-classes,box-model,ids,order-alphabetical,unqualified-attributes | ||
| --exclude-exts=.min.css | ||
| --ignore=adjoining-classes,box-model,ids,order-alphabetical,unqualified-attributes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| **/*{.,-}min.js | ||
| **/*{.,-}min.js |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,3 @@ | ||
| { | ||
| "extends": "react-app" | ||
| } | ||
| { | ||
| "extends": "react-app" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| [ignore] | ||
| .*/__tests__/.* | ||
|
|
||
| [include] | ||
|
|
||
| [libs] | ||
|
|
||
| [lints] | ||
|
|
||
| [options] | ||
| [ignore] | ||
| .*/__tests__/.* | ||
| [include] | ||
| [libs] | ||
| [lints] | ||
| [options] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| # See https://help.github.com/ignore-files/ for more about ignoring files. | ||
|
|
||
| # dependencies | ||
| /node_modules | ||
|
|
||
| # testing | ||
| /coverage | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # misc | ||
| .DS_Store | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* | ||
| # See https://help.github.com/ignore-files/ for more about ignoring files. | ||
|
|
||
| # dependencies | ||
| /node_modules | ||
|
|
||
| # testing | ||
| /coverage | ||
|
|
||
| # production | ||
| /build | ||
|
|
||
| # misc | ||
| .DS_Store | ||
| .env.local | ||
| .env.development.local | ||
| .env.test.local | ||
| .env.production.local | ||
|
|
||
| npm-debug.log* | ||
| yarn-debug.log* | ||
| yarn-error.log* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2017 Hannah Vivian Shaw | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. | ||
| MIT License | ||
| Copyright (c) 2017 Hannah Vivian Shaw | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,71 +1,71 @@ | ||
| <h1 align="center">Flybrary</h1> | ||
| <p align="center">A bookshelf management app written in React with Material-UI & styled-components</p> | ||
|
|
||
| [](https://circleci.com/gh/vivshaw/my-reads) | ||
| [](https://codeclimate.com/github/vivshaw/my-reads) [](https://codeclimate.com/github/vivshaw/my-reads/coverage) | ||
| [](https://my-reads-vivshaw.herokuapp.com/) | ||
| [](https://vivshaw.github.io/my-reads) | ||
|
|
||
| <div align="center"><img src="https://cdn.rawgit.com/vivshaw/my-reads/master/docs/textlogo.svg" alt="flybrary logo" /></div> | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [What It Is](#what) | ||
| - [Installing](#installing) | ||
| - [Testing](#testing) | ||
| - [Deploying](#deploying) | ||
| - [Documentation](#documentation) | ||
| - [To-Do](#to-do) | ||
|
|
||
| ## What | ||
|
|
||
| This is my submission for Project 1 of the [Udacity React Nanodegree](https://www.udacity.com/course/react-nanodegree--nd019). Flybrary | ||
| is a LibraryThing-esque library management app that keeps track of what books | ||
| you're reading. The app uses React & react-router to build an SPA front-end for | ||
| a RESTful books API. It can search for books, add books to shelves, rate them, and move | ||
| them between shelves. It has a responsive, mobile-first style built with Material-UI | ||
| and styled-components that should look equally great on mobile, tablet, or desktop. | ||
| It uses react-loadable for code splitting and react-snapshot for static prerendering. | ||
|
|
||
| [A live demo is available here](https://my-reads-vivshaw.herokuapp.com/). | ||
|
|
||
| ## Installing | ||
| Installation should be a breeze, as this was built with create-react-app & requires | ||
| nothing more than | ||
|
|
||
| ``` | ||
| yarn install | ||
| yarn start | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ``` | ||
| npm install | ||
| npm start | ||
| ``` | ||
|
|
||
| ## Testing | ||
| The app has a full test suite written in Jest & Enzyme that can be run | ||
| with ```yarn test```. A coverage report can be generated with ```yarn test -- --coverage```. | ||
| The repo has CI set up with CircleCI & Codeclimate that will | ||
| automagically run the test suite & generate a coverage report on each git push. | ||
|
|
||
| ## Deployment | ||
| The app has continuous deployment to Heroku on each successful (CI-passing) build of the | ||
| master branch. The latest passing build is at [my-reads-vivshaw.herokuapp.com](https://my-reads-vivshaw.herokuapp.com/). | ||
|
|
||
| For manual deployment, you can ```yarn build```, and then deploy the built app on | ||
| any webserver of your choice. | ||
|
|
||
| ## Documentation | ||
| Flybrary is [fully documented](https://vivshaw.github.io/my-reads/) with JSDoc, and some [documentation.js](http://documentation.js.org/)-generated docs are hosted from the docs directory and are [available here](https://vivshaw.github.io/my-reads/). Unfortunately, the auto-generated docs aren't very good due to the lack of a good ESNext-compatible docs library. It was impossible to use JSDoc or ESDoc due to compatibility problems with certain ES6/ES7 features, and even documentation.js required a Babel transpilation step to get it working & does some weird things with my output. Regardless, the JSDoc in the source itself should be unambiguous. | ||
|
|
||
| To regenerate docs, use ```yarn docs```. | ||
|
|
||
| ## To-Do | ||
| * Eventually, I'd like to migrate to a Redux architecture. | ||
| * I also have a couple Webpack bugs that I don't think I can fully resolve without ejecting and manually reconfiguring. | ||
| * There are a number of performance optimizations that I could tend to. | ||
| * Visual style could be spruced up | ||
| * The test suites are messy & incomplete, in large part due to a) many difficulties working with Material-UI in Jest and b) some trouble injecting mocks. Solving either of these could increase coverage & tidy things up. | ||
| <h1 align="center">Flybrary</h1> | ||
| <p align="center">A bookshelf management app written in React with Material-UI & styled-components</p> | ||
|
|
||
| [](https://circleci.com/gh/vivshaw/my-reads) | ||
| [](https://codeclimate.com/github/vivshaw/my-reads) [](https://codeclimate.com/github/vivshaw/my-reads/coverage) | ||
| [](https://my-reads-vivshaw.herokuapp.com/) | ||
| [](https://vivshaw.github.io/my-reads) | ||
|
|
||
| <div align="center"><img src="https://cdn.rawgit.com/vivshaw/my-reads/master/docs/textlogo.svg" alt="flybrary logo" /></div> | ||
|
|
||
| ## Table of Contents | ||
|
|
||
| - [What It Is](#what) | ||
| - [Installing](#installing) | ||
| - [Testing](#testing) | ||
| - [Deploying](#deploying) | ||
| - [Documentation](#documentation) | ||
| - [To-Do](#to-do) | ||
|
|
||
| ## What | ||
|
|
||
| This is my submission for Project 1 of the [Udacity React Nanodegree](https://www.udacity.com/course/react-nanodegree--nd019). Flybrary | ||
| is a LibraryThing-esque library management app that keeps track of what books | ||
| you're reading. The app uses React & react-router to build an SPA front-end for | ||
| a RESTful books API. It can search for books, add books to shelves, rate them, and move | ||
| them between shelves. It has a responsive, mobile-first style built with Material-UI | ||
| and styled-components that should look equally great on mobile, tablet, or desktop. | ||
| It uses react-loadable for code splitting and react-snapshot for static prerendering. | ||
|
|
||
| [A live demo is available here](https://my-reads-vivshaw.herokuapp.com/). | ||
|
|
||
| ## Installing | ||
| Installation should be a breeze, as this was built with create-react-app & requires | ||
| nothing more than | ||
|
|
||
| ``` | ||
| yarn install | ||
| yarn start | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ``` | ||
| npm install | ||
| npm start | ||
| ``` | ||
|
|
||
| ## Testing | ||
| The app has a full test suite written in Jest & Enzyme that can be run | ||
| with ```yarn test```. A coverage report can be generated with ```yarn test -- --coverage```. | ||
| The repo has CI set up with CircleCI & Codeclimate that will | ||
| automagically run the test suite & generate a coverage report on each git push. | ||
|
|
||
| ## Deployment | ||
| The app has continuous deployment to Heroku on each successful (CI-passing) build of the | ||
| master branch. The latest passing build is at [my-reads-vivshaw.herokuapp.com](https://my-reads-vivshaw.herokuapp.com/). | ||
|
|
||
| For manual deployment, you can ```yarn build```, and then deploy the built app on | ||
| any webserver of your choice. | ||
|
|
||
| ## Documentation | ||
| Flybrary is [fully documented](https://vivshaw.github.io/my-reads/) with JSDoc, and some [documentation.js](http://documentation.js.org/)-generated docs are hosted from the docs directory and are [available here](https://vivshaw.github.io/my-reads/). Unfortunately, the auto-generated docs aren't very good due to the lack of a good ESNext-compatible docs library. It was impossible to use JSDoc or ESDoc due to compatibility problems with certain ES6/ES7 features, and even documentation.js required a Babel transpilation step to get it working & does some weird things with my output. Regardless, the JSDoc in the source itself should be unambiguous. | ||
|
|
||
| To regenerate docs, use ```yarn docs```. | ||
|
|
||
| ## To-Do | ||
| * Eventually, I'd like to migrate to a Redux architecture. | ||
| * I also have a couple Webpack bugs that I don't think I can fully resolve without ejecting and manually reconfiguring. | ||
| * There are a number of performance optimizations that I could tend to. | ||
| * Visual style could be spruced up | ||
| * The test suites are messy & incomplete, in large part due to a) many difficulties working with Material-UI in Jest and b) some trouble injecting mocks. Solving either of these could increase coverage & tidy things up. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| machine: | ||
| node: | ||
| version: 6.0.0 | ||
| test: | ||
| override: | ||
| - npm test -- --coverage | ||
| post: | ||
| - npm install -g codeclimate-test-reporter | ||
| - codeclimate-test-reporter < coverage/lcov.info | ||
| machine: | ||
| node: | ||
| version: 6.0.0 | ||
| test: | ||
| override: | ||
| - npm test -- --coverage | ||
| post: | ||
| - npm install -g codeclimate-test-reporter | ||
| - codeclimate-test-reporter < coverage/lcov.info |
Oops, something went wrong.