Clementine.js is a lightweight boilerplate for fullstack JavaScript development which utilizes MongoDB, Express and Node.js. Clementine.js errs on the side of transparency and simplicity as an alternative to more complex boilerplates.
The Angular boilerplate is a slightly modified version of the standard boilerplate which integrates Angular functionality.
- Standard: 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 (this version): 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.
In order to use Clementine.js, you must have the following installed:
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-angular.git your-projectThis 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:angularNote: 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!
This is an open-source project, and contributions are always welcome! To see ways to contribute, please review the contribution guidelines.
Complete documentation can be found here.
You can find a complete step-by-step tutorial on how to create this app from the ground up here.
| 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 |
MIT License. Click here for more information.