From 46e384ae40439e43d000371eae0df44c6883c13c Mon Sep 17 00:00:00 2001 From: Thomas Kelly Date: Thu, 27 Jul 2017 15:41:29 -0400 Subject: [PATCH] update start instructions --- README.md | 23 ++++++++++++++++++++--- 1 file changed, 20 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index befa210..78d48b8 100644 --- a/README.md +++ b/README.md @@ -10,10 +10,27 @@ Follow along with the workshop to make your own! This canonical version can serv To use this boilerplate, you'll need to take the following steps: -* Fork and clone this repo. -* `cd` into your clone and `rm -rf .git` to remove the boilerplate git tracking +* Don't fork or clone this repo! Instead, create a new, empty directory on your machine and `git init` (or create an empty repo on Github and clone it to your local machine) +* Run the following commands: + +``` +git remote add boilermaker https://github.com/FullstackAcademy/boilermaker.git +git fetch boilermaker +git merge boilermaker/master +``` + +Why did we do that? Because every once in a while, `boilermaker` may be updated with additional features or bug fixes, and you can easily get those changes from now on by entering: + +``` +git fetch boilermaker +git merge boilermaker/master +``` + +## Customize + +Now that you've got the code, follow these steps to get acclimated: + * Update project name and description in `package.json` file -* `git init` to start your own git tracking * `npm install`, or `yarn install` - whatever you're into * Create two postgres databases: `boilermaker` and `boilermaker-test` (you can substitute these with the name of your own application - just be sure to go through and change the `package.json` and `server/db/db.js` to refer to the new names) * By default, running `npm test` will use `boilermaker-test`, while regular development uses `boilermaker`