personal-website

Nick Bartlett's personal website. It's currently a WIP.

Installation

After forking and cloning the codebase, run the following command to install all of the dependencies:

npm install

Running

Running the site for development is a single command:

npm run gulp

This will run Gulp, starting the Node server. The task wraps the Node server in a proxy server that will be accessible on multiple devices, live reload assets, and watch Node files for changes to stop and start the Node server on changes. It will also lint all of the JavaScript and Sass, compile the Sass, uglify the JavaScript, and optimize the images.

Testing and Deploying

Testing and deploying is all done through Travis. Whenever a commit comes in to any branch of the repository, Travis will start up and run npm test (found in the scripts property in package.json). If it finds any errors, it'll be angry 😡 and they'll need to be fixed. Once all of the tests pass, Travis will be happy again 💚.

If a commit comes in to the master branch and all of the tests pass, Travis will use heroku to create a deployable app from the source code and deploy it on heroku.

Current Project make-up

Pretty bare-bones at the moment.

• src - Browser source files
  • src/js - Browser JS files. Will build to public/js and be available in the /js folder from the browser
  • src/images - Images available to the browser. Will build to public/images and be available in the /images folder from the browser
  • src/sass - Sass files to be compiled to CSS. Will build to public/css and be available in the /css folder from the browser
• lib - Node source files
• views - Templates to be rendered by the Node server
• index.js - Main application file

The following folders contain generated content and will not be included in the source control:

• public - The folder browser assets will be served from.
• node_modules - The folder containing Node dependencies

The following files are configuration files to configure different parts of the toolchain:

• gulpfile.js - Gulp configuration file
• .nvmrc - NVM version configuration
• .editorconfig - EditorConfig configuration
• .eslintrc.yml - ESLint lint rule configuration
• .sass-lint.yml - Sass Lint lint rule configuration
• .travis.yml - Travis configuration
• .gitignore - Git source control ignore file