Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 4 KB

README.md

File metadata and controls

82 lines (60 loc) · 4 KB
Raw

Create reSolve App 🚀

npm version

This package creates an empty application based on the reSolve framework (hello-world example). Use the --example option to create a single page application (SPA) based on another example. The application is built on the CQRS and Event Sourcing principles using React + Redux on the client.

Create reSolve App allows you to specify application blocks (aggregates, read models, and UI part React components present) in a semi-declarative manner. With the resolve-scripts package, you do not need to write an API backend manually. Instead, resolve-scripts deploys backend and domain services to interact with the client which is wrapped in the resolve-redux package for an automated interaction.

Refer to https://github.com/markerikson/react-redux-links for detailed information on subject-related technologies and links to the corresponding resources.

Available options:

  • --example <folder> creates appropriate application from examples folder in resolve repo. hello-world is default
  • --branch <branch>, --commit <sha> - you can specify if you need example from specific brach or even commit
  • --version or -V outputs the version number

Quick Overview 🔎

Note: Installing a package globally may require administrative privileges. This means you have to use the sudo command for Unix-based systems or run a terminal with administrative privileges on Windows systems.

npm i -g create-resolve-app
create-resolve-app my-resolve-app
cd my-resolve-app
npm run dev

Terminal Your app will be opened in the browser at http://localhost:3000/.

Getting Started

Create an App

Create a new reSolve application in one of the following ways:

using yarn...

yarn create resolve-app my-resolve-app

...or npx:

npx create-resolve-app my-resolve-app

...or npm:

npm i -g create-resolve-app
create-resolve-app my-resolve-app

This creates the my-resolve-app directory in the current folder and generates the initial project from specified example.

Available Scripts 📋

Once the installation is completed, you can run the following commands in the project directory to start your app:

npm run dev or yarn dev

Runs the app in the development mode. Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits. You will also see any errors in the console.

npm run build or yarn build

Builds client and server bundles for production through Webpack.

Building is performed in the NODE_ENV === 'production' mode, so the build is optimized. No additional HTTP server for the serving client bundle and assets are built.

npm start or yarn start

Runs the app from the build directory.

npm test or yarn test

Runs unit run tests with Jest.

npm run test:functional or yarn test:functional

Runs functional tests with TestCafe.

User Guide

The User Guide provides detailed information on an application created with Create reSolve App:

A copy of the user guide is added to your project folder as the Readme.md file.