Skip to content

Typo corrections #252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ddavisgraphics merged 3 commits into from
Dec 18, 2016
Merged

Typo corrections #252

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8ddee78
Merge pull request #244 from wvulibraries/ExportingUpdate
Nov 17, 2016
8c55181
Merge pull request #248 from wvulibraries/develop
Nov 28, 2016
13d8941
Typo corrections
MichaelRBond Dec 11, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions public_html/includes/js/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# JavaScript Tooling for Deployment

For organization and maintainablility the files have been broken up, but for deployment are concatenated togather for performance. Also for performance reasons the files have been broken up by job specific / page specifics within the application.
For organization and maintainability the files have been broken up, but for deployment are concatenated together for performance. Also for performance reasons the files have been broken up by job specific / page specifics within the application.

## Changing JS
## Changing JS

Modify JS files only in the develop folder. The build files will be built using grunt.

## GRUNT / NODE
## GRUNT / NODE

Compiling NPM / Node Modules needed to run grunt.

Expand All @@ -17,13 +17,13 @@ Running Grunt to Make Changes to the JS

* ```cd mfcs``` -- Change directory to MFCS Main Directory
* ``` grunt ``` -- Runs grunt does tasks in ```Gruntfile.js```

## SCSS

Running grunt will also compile and manipluate your SCSS. You can setup and add other libraries using NPM to modify SCSS you just have to update the Gruntfile.js to add those into the build. May want to look at something like Autoprefixer and liniting for getting cleaner SCSS. Looking at breaking the SCSS into more library like items and keeping it dryer might be good as well.

## TODO
## SCSS

Running grunt will also compile and manipulate your SCSS. You can setup and add other libraries using NPM to modify SCSS you just have to update the Gruntfile.js to add those into the build. May want to look at something like Autoprefixer and linting for getting cleaner SCSS. Looking at breaking the SCSS into more library like items and keeping it dryer might be good as well.

## TODO

* Update Minification Settings for JS
* Performance Tooling and Testing
* Modularize the UI using something like Webpack or RequireJS
* Modularize the UI using something like Webpack or RequireJS