ecrit

Écrit
=====
IPA: /e.kʁi/ - that's "eh-cree"


    

An extremely-opinionated Node app framework. Écrit is highly oriented toward readability, accessibility and logical, intuitive code organization. MongoDB is the database of choice here.
Use this framework as a more versatile alternative to Ghost or Wordpress, or if you've used a similar framework like Sails but prefer Literate CoffeeScript as much as we do.

Install
-------

First, make sure you have a Mongo database running somewhere.
If you're using a hosted service like Compose, have your database's URL, username and password on hand, you'll need them for the following steps.

_Note:_ If you're just developing or want to use a self-hosted MongoDB, you'll need to Install MongoDB if it's not already installed. Make sure you run mongod (may require sudo) and in another Terminal, confirm the DB is running with netstat -an | grep 27017. If you get any results, Mongo is running.

Next, install Écrit via NPM. Open up your Terminal and type

npm install -g ecrit

The -g flag is mandatory, as this is a command-line tool.

Now you're good to go! Type ecrit -v to confirm you've installed it and see which version you're using.

Quick Start
-------

``
ecrit create exampleApp
cd exampleApp && ecrit start
`

Commands
--------

#### ecrit create

Creates an app at folder within the current working directory.
If the folder doesn't exist, it will be created.
If the folder exists and is empty, Écrit will copy a new app to the directory.
If the folder exists and is not empty, Écrit will return an error.

#### ecrit start

Starts an Écrit app. Must be within , cannot be invoked from subdirectories or parent(s).
If no provided, defaults to 'development'.

If called with production, Écrit automatically launches your app as a cluster of processes in the background and load-balances them between all CPU threads for production use.

#### ecrit show

Shows info about an Écrit app cluster with the given .
If no , assumes current directory.

#### ecrit restart

Restarts an Écrit app cluster (0s downtime!) with the given .
If no , assumes current directory.

#### ecrit stop

Stops an Écrit app cluster with the given .
If no , assumes current directory.

#### ecrit destroy

Destroys an Écrit app cluster with the given .
If no , assumes current directory.

#### [ecrit test [option]](/bin/test.litcoffee)

Runs unit tests for the framework. Currently only --console` option is supported.

Contributing
------------

See the Contributing guide. There's plenty of room for collaboration!

###### TODO

* Finish building out tests
* Design and build out Dashboard features
* Add remote server management support so users can scale past 1 machine's CPU cores