Node Skeleton
Project Setup
- Create your own empty repo on GitHub
- Clone this repository (do not fork)
- Suggestion: When cloning, specify a different folder name that is relevant to your project
- Remove the git remote:
git remote rm origin
- Add a remote for your origin:
git remote add origin <your github repo URL>
- Push to the new origin:
git push -u origin master
- Verify that the skeleton code now shows up in your repo on GitHub
Getting Started
- Create the
.env
by using.env.example
as a reference:cp .env.example .env
- Update the .env file with your correct local information
- Install dependencies:
npm i
- Fix to binaries for sass:
npm rebuild node-sass
- Run migrations:
npm run knex migrate:latest
- Check the migrations folder to see what gets created in the DB
- Run the seed:
npm run knex seed:run
- Check the seeds file to see what gets seeded in the DB
- Run the server:
npm run local
- Visit
http://localhost:8080/
Dependencies
- Node 5.10.x or above
- NPM 3.8.x or above