This project creates a Vanilla JS App utilized on the client side to communicate SOFWERX Github information.
For development, you will need Node.js installed on your environement. And please use the appropriate Editorconfig plugin for your Editor (not mandatory).
Node is really easy to install & now include NPM. You should be able to run the following command after the installation procedure below.
$ node --version
v0.10.24
$ npm --version
1.3.21
You will need to use a Terminal. On OS X, you can find the default terminal in
/Applications/Utilities/Terminal.app.
Please install Homebrew if it's not already done with the following command.
$ ruby -e "$(curl -fsSL https://raw.github.com/Homebrew/homebrew/go/install)"
If everything went fine, you should run
brew install node
sudo apt-get install python-software-properties
sudo add-apt-repository ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs
Just go on official Node.js website & grab the installer.
Also, be sure to have git available in your PATH, npm might need it.
You should have already installed node.js on your machine and cloned the repo however if you haven't please visit GitHub and proceed through the following instructions.
$ git clone https://github.com/sofwerx/sofwerx.github.io.git
$ cd sofwerx.github.io
$ npm i
In the project directory, you can run:
Runs the app in the development mode.
Open http://localhost:1234 to view it in the browser.
The page will reload if you make edits.
You will also see any lint errors in the console.
Launches the test runner in the interactive watch mode.
See the section about running tests for more information.
Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!
See the section about deployment for more information.
Note: this is a one-way operation. Once you eject, you can’t go back!
If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
Some packages usages might change so you should run npm prune & npm install often.
A common way to update is by doing
$ git pull
$ npm prune
$ npm i
To run those 3 commands you can just do
$ npm run pull
Note: Unix user can just link the git-hooks/post-merge:
$ npm run create-hook-symlinks
This hook will npm prune && npm install each time you git pull something if the package.json has been modified.
This project is created as a React App and all html is templated through the different react components and js files.
- React is used for UI.
- JSHint is used to prevent JavaScript error.
- JSCS is used to check coding conventions.
- Browserify to handle allow us to write our client-side scripts with es6 syntax thanks to es6ify.
- sass/node-sass is used to write futureproof CSS for CSS vendor prefix under the hood).
Autoprefixer is included and use caniuse.com database to avoid outdated prefixes. You can forget CSS prefixes NOW.
The app embed for development a static connect server with livereload plugged. So each time you start the app, you get automatic refresh in the browser whenever you update a file.
You can learn more in the Create React App documentation.
To learn React, check out the React documentation.
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify