Skip to content

britolliver/Capstone

Repository files navigation

Savvy Coders Project Boilerplate Starter Kit

Overview

This template repository contains several opinionated, 'starter' files and settings to help Savvy Coder students focus more time and energy on learning how to code and/or craft 'business logic' for projects and less time on configurations.

In addition to a '.gitignore' and some VS Code specific extensions and settings, it includes the 'recommended' settings for:

  1. ESLint
  2. Stylelint
  3. Prettier

Get Started

First and foremost, make sure that your local machine is set up with all of the 'dev environment tooling' as per the instructions in the curriculum.

Well, after establishing your directory structure on your local machine, (e.g. '~/Code/SavvyCoders'), clone the Savvy Starter Repo - essentially, there should be a button that says Use this template.

Read more about using templates on GitHub here...

Once this repo has been created on your GitHub, you can click on the button to 'clone' it as usual.

Once it's cloned to your local machine, cd into the directory and be sure to do: npm i to get all of the dependencies installed. If you see any errors (warnings are OK) on Windows, you may have to do npm install.

Now, enter code . to open this project in VS Code, and look for a prompt to 'install some extensions' once inside VS Code (in the bottom right of your screen). You should install these.

In your repo, feel free to update this README and make any other initial changes to files, etc. Then go ahead and do your usual git steps -- add, commit, and push.

Note: This is a template repository, no need to 'fork it.