https://github.com/smartprix/node_starter_project
This is an empty project for quickly starting up with nodejs.
https://github.com/smartprix/node_starter_project
Last synced: about 2 months ago
JSON representation
This is an empty project for quickly starting up with nodejs.
- Host: GitHub
- URL: https://github.com/smartprix/node_starter_project
- Owner: smartprix
- Created: 2016-06-29T13:25:08.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2016-12-21T05:07:40.000Z (over 8 years ago)
- Last Synced: 2025-03-25T05:03:25.440Z (2 months ago)
- Language: JavaScript
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NodeJS Starter Project
This is an empty project for quickly starting up with nodejs.
#### Features:
* git & git-hooks
* eslint & default conventions (https://github.com/smartprix/js_conventions)
* babel
* testing with mocha and chai
* production running with pm2
* lodash and sm-utils already installed
#### Conventions:
* Keep all your source code in src directory
* Keep all your test cases (with mocha) in test directory
* Compiled code (from babel) will be stored in dist directory
* Keep all your garbage files (temporary testing and all) in garbage directory
#### How To Start:
* Clone this directory
* Update dependencies `ncu -u` and then run `yarn`
* You are ready. Start writing your code in `src/index.js`
#### Commands:
```bash
# Run eslint to check coding conventions
eslint src
# Or Alternatively
npm run lint
# Run tests
npm test
# Compile Files
npm run build
# Start dev server which autoreloades on changes (using nodemon)
npm start
```