Cherry Documentation

Cherry Documentation

  • Docs
  • Help
  • Blog

›Getting Started

Getting Started

  • Overview
  • Installation
  • Create a server
  • Adding routes
  • What's next ?

Routing

  • Public resources
  • Basic routes
  • Route contexts
  • Middlewares
  • Redirections

Views & Server response

  • Default error pages
  • Render a html view
  • Render a json payload
  • Download response

Plugins

  • Overview
  • View rendering plugins
  • ORM Plugins
  • Request Plugins
  • Create your own plugins

Miscellaneous features

  • Hooks
  • Server Config
  • Coming Soon...

Best Practices

  • Best Practices

Installation

Cherry is pretty simple to install. Like any npm package.

Requirements

First of all, you'll need to match the requirement of the framework.

Because it is a backend Javascript framework, you'll need to install Node.js.

Cherry is tested to work for node >= 10. The version under Node 10 may work or not but they are not supported.

To check you Node.js version, you run this command in a terminal :


$ node -v
v12.4.0

Download Cherry

To download Cherry and get it in your project, go in you project folder and run this command :


$ npm i @lund-org/cherry
or
$ yarn add @lund-org/cherry

Or if you need to install it for production :


$ npm i @lund-org/cherry --production
or
$ yarn add @lund-org/cherry && yarn install --production

And that's it, you now have Cherry in your dependencies. Let's see how to use it in the next chapter !

← OverviewCreate a server →
  • Requirements
  • Download Cherry
Cherry Documentation
Docs
Getting StartedGuides (TODO)API Reference (TODO)
Community
User Showcase (TODO)Project ChatTwitter
More
BlogGitHubStar
Copyright © 2020 Lund-Org