Skip to content

The elegant and lightweight full stack JavaScript boilerplate.

License

Notifications You must be signed in to change notification settings

jondcoleman/clementinejs-react-basic

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React Fork of the project - run gulp to transform and browserify jsx files into main.js.

App Running on Heroku

Clementine.js Boilerplate

Join the chat at https://gitter.im/johnstonbl01/clementinejs

Overview

Clementine.js is a lightweight boilerplate for fullstack JavaScript development which utilizes MongoDB, Express and Node.js. Coming in at just under 32 KB, Clementine.js is a perfect alternative to more feature-dense boilerplates.

Clementine.js errs on the side of transparency and simplicity, making it an ideal starting point for beginner and seasoned developers alike. Note that this implementation assumes the developer wishes to perform implementation of more complex features him- or herself.

Versions

There are 3 versions of Clementine.js:

  • Standard (this version): the simplest version of Clementine.js. Intended for those who wish for the smallest and least intrusive footprint OR to implement features on their own.
  • Angular: a slightly more complex version of the same application. This version employs the use of AngularJS as the front-end framework.
  • Free Code Camp (FCC): A modified version of the standard boilerplate that is intended for use with the Free Code Camp curriculum.

Quick Start Guide

Prerequisites

In order to use Clementine.js, you must have the following installed:

Installation & Startup

There are 2 ways to install Clementine.js:

  • Clone the GitHub Repository
  • Install via Yeoman Generator

Both options are similar, and a matter of preference.

Option 1 - Clone GitHub Repo

$ git clone https://github.com/johnstonbl01/clementinejs.git your-project

This will install the Clementine.js components into the your-project directory.

Option 2 - Yeoman Generator

$ npm install -g generator-clementinejs
$ mkdir your-project
$ cd your-project
$ yo clementinejs

Note: generator-clementinejs must be installed globally.

To start the application, browse to the project directory and type: $ node server into the terminal window. Point a browser to localhost:3000 and you're up and running!

Contributing

This is an open-source project, and contributions are always welcome! To see ways to contribute, please review the contribution guidelines.

Documentation

Complete documentation can be found here.

Tutorial

You can find a complete step-by-step tutorial on how to create this app from the ground up here.

Features

Features Standard Angular FCC
MongoDB Yes Yes Yes
Express Yes Yes Yes
AngularJS (1.x) No Yes No
Node.js Yes Yes Yes
Passport No No Yes
Mongoose No No Yes

License

MIT License. Click here for more information.

About

The elegant and lightweight full stack JavaScript boilerplate.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages