First Time Setup

Assumptions

This repo assumes you have access and at least some working knowledge of the following technologies:

• A Unix-based operating system such as Mac OS or Linux with administrator privileges
• Access to the command line
• Git/GitHub for version control, using feature branches
• A code editor such as Code, Atom or Sublime Text that can work with code linters
• Raster and vector image editors, such as Photoshop and Sketch (or their browser-based alternatives)

Additionally, familiarity with the following techniques will be helpful:

• A mobile-first workflow with a mind to performance and accessibility
• Device agnostic, resolution independent components that use relative sizing units
• Modular scale typography

Scaffolding

Follow these steps to prepare, configure, and deploy you project:

Preparation

1. Clone the project to your desired local location, naming the folder after something that relates to your project: git clone [email protected]:ericwbailey/enchilada.git
2. Run git-labelmaker and delete the default GitHub Issue labels
3. Pick a suitable license and update it in LICENSE
4. Tweak linters as desired
5. Change each instance of * for each line featuring a Global Project Variable in the Makefile for the replace task
6. Run make. This will change node to use version 7 via nvm, update project variables in the code, install project dependencies, and build and run the project

Configuration

1. Review CHANGELOG.md and update as needed
2. Review README.md and update as needed
3. Review package.json and update as needed
4. Search the code for REVIEW: to check for things you might want to tweak
5. Integrate additional vendor libraries and services, if desired

Deploy

1. Enable publishing from GitHub Pages if you want to host on GitHub
2. Push code back up to your new GitHub project repo
3. For other sessions, run gulp from the command line to rebuild the project and open it in your default browser

Flow

This is the overall approach for how to publish your work. See Command Line Tasks and Explanation of Branches for more detail.