This bomber boilerplate is a humble tribute to The Man himself, the Godfather of Heavy Metal, the Hellraiser: Lemmy Kilmister.
Perhaps you may have heard of him as the trust-worthy roadie of Jimi Hendrix, the raw base of the 70's space rock powerhouse Hawkwind or, most probably, as the relentless force behind the all-mighty Motörhead. If you have not had the distinct pleasure of listening to ripping, mean, and kick-ass rock'n'roll he makes you might want to check it out! Meanwhile, forget about the typical web framework development overkill and take Lemmy for a spin! It could be your rocking ace of spades!
The idea behind Lemmy is simple: Express.js development on speed!
Dedicated to all the beer drinkers and Hell raisers out there!
You have to use a UNIX-like or a BSD-like system that supports Makefiles and uses Bash shell. You also need Git source code management system and Node.js installed on your machine. That's all you need!
Optional: You might want to have a bottle of Jack Daniel's at hand!
It is very easy to start using Lemmy. In fact, all you need to do is:
- Fork this project and rename it as you like.
git clone https://github.com/rock-n-code/lemmy your_project_name
- Setup your project and choose your language of choice
cd your_project_name && make setup [LANGUAGE=cs] [TYPE=standard|modular] [ENGINE=ejs|jade]
Modify the package.json file to your requirements with your Text Editor of choice.
Install all the dependencies locally.
The commands Lemmy provides you are:
- setup : Kick-starts your JS/CS Express project for once and for all.
- clean : Cleans up all the generated code from your Express project.
- update : Updates all the Lemmy files on your project.
- dependencies : Installs locally all the dependencies defined on the package JSON file.
- app : Generates a new Application file and its respective Test file into your project.
- layout : Generates the layout and respective assets into your project or apps within the project.
- module : Generates a new Module file and its respective Test file into your project.
- helper : Generates a new Helper file and its respective Test file into your project.
- middleware : Generates a new Middleware file and its respective Test file into your project.
- route : Generates a new Route Container file and its respective Test file into your project.
- controller : Generates a new Controller file and its respective Test file (and views) into your project.
- model : Generates a new Model file and its respective Test file into your project.
- view : Generates a new View file into your project.
- partial : Generates a new Partial file into your project.
- build : Compiles your CS code into the JS equivalent.
- watch : Watches any change on your CS code and automatically compiles it into its JS equivalent.
- run : Runs your project on Development environment.
- run-as-production : Runs your project on Production environment.
- test : Tests your Express project using Mocha.
- prepare : Prepares your Express project for deployment.
- mit-license : Generates a MIT license for your Express project.
- help : Displays the Help menu you're reading right now.
- version : Displays the version of Lemmy that you've installed on your machine.
This is the list of all the required and/or wish features that will be implemented on Lemmy in the near future, in random order:
- Integrate Mobile HTML5 boilerplate as a layout.
- Integrate Twitter's Bootstrap as a layout.
- Integrate jQuery Mobile as a layout.
- Universal support.
The following people are helping to make Lemmy an essential tool for every Express developer:
No matter how small or big your contribution to this project is, you'll be added to this list by default.
Lemmy relies on the invaluable contribution done by the Open Source community and, in particular, the immense contribution of certain individuals who have kick-started some of the greatest and most useful tools ever created for developers:
- Makefile by Stuart Feldman
- Git by Linus Torvalds
- Node.js by Ryan Dahl
- Express, Mocha, EJS and Jade by TJ Holowaychuk
- Coffee-Script by Josh Askhenas
- Jitter by Trevor Burham
- Request by Mikeal Rogers
- HTML5 boilerplate by Paul Irish
- 1140 CSS Grid by Andy Taylor
Moreover, I also would like to thank the following blogs and sites for featuring Lemmy:
Copyright (c) 2011-2012 Javier Cicchelli <email@example.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.