RecifeJs

RecifeJs

  • Docs
  • Blog
  • Github

›Getting Started

RecifeJs

  • About
  • Philosophy
  • Contribution

Getting Started

  • Installation
  • Settings

Concepts Basics

  • Controllers
  • Decorators
  • Middlewares
  • Models
  • Plugins
  • Scalars
  • Validators

CLI

  • Introduction
  • Create Structures

Installation

The installation of RecifeJs is very simple and can be done in minutes.

Server requirements

The structure of RecifeJs needs very few requirements. See requirements below.

  • Git
  • Node >= 8.0
  • NPM >= 3.0

Installation RecifeJs CLI

The RecifeJs CLI is the command-line interface for using all the powerful features of RecifeJs.


Install RecifeJs CLI:

npm install -g recife-cli


To create a new project and see all the benefits of RecifeJs, run the following command:

recife project my-project-name
cd my-project-name


Start the new project with this command.

npm run server


For more details visit the CLI topic.

Using via npx

If you do not want to install the CLI it is also possible to use it via npx. Below is an example of its use to create a new project.

npx recife-cli project my-project-name
cd my-project-name
npm run server

For more details visit the CLI topic.

Last updated on 6/27/2020 by André Lins
← ContributionSettings →
  • Server requirements
  • Installation RecifeJs CLI
  • Using via npx
RecifeJs

Docs

Getting StartedCLIPhilosophy

Community

User ShowcaseProject ChatBlogGitHubStar
Copyright © 2020 RecifeJs