Code Monkey home page Code Monkey logo

node_template's Introduction

Build Status

Readme

Why?

Better question is why not? I've created this project because I want to eliminate the time I spend bootstrapping my newest projects.

project-bootstrap aims to give developer a clean bootstrapped project which he/she can then immediately use for building the next best thing.

Requirements

NodeJs version ~5.6.0

Development

When you are ready to start developing simply run:

npm run dev

This will bring up the node server on http://localhost:3000/ and listen to all the changes you make in your code. If change is detected node server (nodemon) is restarted or frontend code (js, scss) is rebuilt.

Ready to deploy?

You think you have finished and you are ready to deploy? Run:

npm run build

This will compile your frontend code from src and put it into public folder. It will also minify and copy all the images from src/images to public/images. Be aware that build command reads the NODE_ENV variable and based on the setting it builds the appropriate version of your assets. Set NODE_ENV=production to build production version of your code.

You can force production build with npm run build:prod.

Differences between development and production:

development production
compile js with babel yes yes
js source maps yes no
minified compiled js no yes
compile scss yes yes
atuo-prefixed css no yes
scss source maps yes no
minified css no yes
versioned assets no yes

Docker

There is a Dockerfile which you can use for running this project in a docker container. If you don't know what docker is or how to use it I suggest you to have a look at this:

Docker Tutorial - What is Docker & Docker Containers, Images, etc?

Credits to LearnCode.academy

Todos

  • Add tests for controllers
  • Find a good way to successfuly test the whole flow (BDD)
  • Create generators for code (e.g.: npm run generate controller user)

node_template's People

Contributors

mihaerzen avatar greenkeeperio-bot avatar mfpiccolo avatar 19h avatar

Watchers

James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.