Kickoff for ExpressJS applications.
Get the latest version of node from the official website or using nvm Nvm approach is preferred.
Run npm install from rootpath of the project.
Run node ./scripts/kick-off.js from project's rootpath to remove the existing sample project and start developing your app.
Before running the app, make sure you must have a postgres db created. Then, set the $NODE_API_DB_URL environmental variable. It should look something like: postgres://username:password@host:port/databasename.
For more information feel free to glance at the app/orm.js file.
Now, to start your app run npm start in the rootpath of the project. Then access your app at localhost:port. The port is logged in the console where you ran the start script.
By default, the environment will be development, but you can easily change it using the NODE_ENV environmental variable.
As we know, a NodeJS application is not something easy to debug and because of that we've added the devtool package to make it simpler. It will get started when running your app using the start script (npm start), making your debugging easier with some of the features of Chrome DevTools.
Pushing the desired branch to heroku should be enough. For more information check: https://devcenter.heroku.com/articles/getting-started-with-nodejs#define-a-procfile. project.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request
This project is maintained by Michel Agopian and it was written by Wolox.
express-js-bootstrap is available under the MIT license.
Copyright (c) 2017 Michel Agopian <michel.agopian@wolox.com.ar>
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.