npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ecrit

v1.0.11

Published

An extremely-opinionated Node app framework.

Downloads

19

Readme

Écrit

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

NPM

Travis CI Build Status NPM Downloads Dependency Status License Gratipay

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 <app name>

Creates an app at folder <app name> 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 <environment>

Starts an Écrit app. Must be within <app name>, cannot be invoked from subdirectories or parent(s).
If no <environment> 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 <app name>

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

ecrit restart <app name>

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

ecrit stop <app name>

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

ecrit destroy <app name>

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

ecrit test [option]

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