Blvd-utils NPM

boulevard

This project is in a pre-alpha state, and none of the APIs described below should be considered implemented. When boulevard reaches a state where all of the planned features are implemented, i.e. 0.1, this warning will be removed. Until this warning is removed, do not be surprised if nothing works, because we haven't built it yet.

Boulevard is a framework for building full-stack apps on JavaScript. If it was a dog, it would be a Samoyed - not too big, but very powerful, and capable of herding small children.

// TODO: Code sample? Not sure how to depict

Getting Started

Requirements

Boulevard has a couple of requirements before you start using it:

Node: If you haven't already, install and download Node from here. You must have Node installed, and it must be version 4 or above. You should avoid odd number releases (i.e. 5 or 7), especially for development apps.
Yarn: Not a strict requirement, but it's for your own good. You can download and install it here.

Starting a Project

To get started, open up any command line and install the boulevard cli:

npm install -g blvd-cli
mkdir my-blvd project
cd my-blvd-project
blvd init

The CLI will download and set up your first blvd project. From there, you can host your server right off the bat:

blvd develop

Now, open up any web browser and navigate to http://localhost:8080. You've just set up your very own boulevard project! The hello world page will link you to further documentation and guides.

Issues and Feature Requests

We use github issues to track issues with boulevard. You can post any issues or feature requests you have there. If you have a question, or need support for boulevard, use StackOverflow. (We hope to set up a Discourse instance in the near future.)

Contributing

For more information on setting up a local copy of the repo and getting started on your very first pull request, read CONTRIBUTING.md.

Packages

Boulevard is managed as a monorepo with independent versioning.

Core

Package	Version
`blvd`
`blvd-server`
`blvd-client`

The three core packages handle creating and serving a blvd server. Theoretically, you can use blvd just like this, but the view adapters make it much easier to write a client.