To use this as boilerplate, you'll need to take the following steps:
-
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) -
Now you will have to add the fs-app-template as a remote and merge it into your own repository.
git remote add boilermaker git@github.com:FullstackAcademy/fs-app-template-v2.git
git fetch boilermaker
git merge boilermaker/main
git branch -m master main
Now that you've got the code, follow these steps to get acclimated:
- Update project name and description in
package.json npm install- Create two postgres databases (
MY_APP_NAMEshould match thenameparameter inpackage.json): - These commands will create both your development and test databases
createdb <YOUR APP NAME HERE FROM package.json>
createdb <YOUR APP NAME HERE FROM package.json>-test
- By default, running
npm testwill use your test database, while regular development uses development database
Sync and seed your database by running npm run seed. Running npm run start:dev will make great things happen!
- start:dev will both start your server and build your client side files using webpack
- start:dev:logger is the same as start:dev, but you will see your SQL queries (can be helpful for debugging)
- start:dev:seed will start your server and also seed your database (this is useful when you are making schema changes and you don't want to run your seed script separately)