RaMEN Starter Project

React, MongoDB, Express, & Node

Features

Client

• webpack and webpack-dev-server as a client-side module builder and module loader.
• React and JSX as a virtual Dom JavaScript library for rendering user interfaces (views).
• Redux as an incredibly simple way of modelling your data app state, with great community support.
• Redux DevTools Extension as a live-editing environment for your Redux apps.
• eslint-plugin-react for additional React specific linting rules.
• Sass as a compiler of CSS styles with variables, mixins, and more.

Server

• Node as an event-driven, non-blocking I/O model that is lightweight and efficient.
• Express is a fast, un-opinionated, minimalist web framework for Node.js
• MongoDB as a document-oriented database designed for scalability.
• Mongoose is an elegant mongodb object modeling system for node.js

Shared

• npm as a package manager and task runner (say NO to gulp/grunt).
• Babel 6 as a transpiler from ES6 to ES5.
• ESLint as a reporter for syntax and style issues.
• Mocha as a test framework.
• Chai as a BDD assertion library that works along with Mocha.

Getting Started

Install the app

$ git clone https://github.com/towen/ramen.git RaMEN
$ cd RaMEN
$ npm install

Add the sample data

$ npm run seed

Start the app

$ npm start

Development

• Development via the webpack dev server:
  • $ npm start
  • Open http://localhost:3000/ in your browser, pages ‘hot reload’ automatically when there are changes

Production

• Production client:
  • $ npm run build
  • Located in ./build

Testing

$ npm test

TODO

• Make the whole project less opinionated
• Implement Flow for type checking
• Add more tests

License

MIT