This is a boilerplate project used for starting new projects!
Complete the following steps to start a new project (NEW-PROJECT-NAME):
- Clone this repository to your local machine
git clone https://github.com/zempo/node_boilerplate.git NEW-PROJECTS-NAME
cd
into the cloned repository- Make a fresh start of the git history for this project with
rm -rf .git && git init
- Install the node dependencies
npm install
- Move the example Environment file to
.env
that will be ignored by git and read by the express servermv example.env .env
- Edit the contents of the
package.json
to use NEW-PROJECT-NAME instead of"name": "express-boilerplate",
- Run
npm i knex
and thennpm i pg
(for postgres, in this case). - Reference the Knex Documentation for more.
- A sample db url has been added to the example env
- Getting started
const knex = require("knex");
const knexInstance = knex({
client: "pg",
connection: process.env.DB_URL
});
console.log("connection successful");
Start the application npm start
Start nodemon for the application npm run dev
Run the tests npm test
When your new project is ready for deployment, add a new Heroku application with heroku create
. This will make a new git remote called "heroku" and you can then npm run deploy
which will push to this remote's master branch.