Skip to content

Commit

Permalink
update start instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tmkelly28 committed Jul 27, 2017
1 parent 4c12e70 commit 46e384a
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down

0 comments on commit 46e384a

Please sign in to comment.