t-rex-js

t-rex-js

t-rex-js allows quick development of full-stack web applications using react, express, and sequelize. It also uses socket.io to support real-time dynamic interfaces.

Installation

npm install -g t-rex-js

Quickstart

Create a project and open the project:

t-rex create
cd <project_name>

Install server and client dependencies (from project root directory):

t-rex install

Provide a valid database url in config.json:

"db_url" : <valid database url>

Start the application (from project root directory):

t-rex run

Usage

Creating a project

t-rex create

The create command creates a t-rex project in the current working directory. Project details will be prompted by the CLI.

Install project dependencies

t-rex install

Installs all required packages for both the server and a client. This command is a macro for the following:

npm install
cd client
npm install

This command is currently available only in the root directory of the project.

Run project

t-rex run

Runs the express server (backend) and the webpack development server for the react frontend. This command is a macro for the following:

yarn run start
cd client
yarn run start

This command is currently available only in the root directory of the project.

config.json

This file contains all of the editable system defaults supported by t-rex.

Adding a resource

t-rex add

The add command creates the ff:

• A resource located in the /resources/<resource_name> folder containing a dummy model for the resource
• A react component in /client/src/components which displays all instances of the model associated with the resource
• The resource is then incorporated into the app via /resources/index.js

NOTES:

• If there is no valid db_url in config.json, running your application after adding a resource causes the Express server to crash.
• The add command's generated resource.js and model.js requires the user to insert model attributes (To be fixed)

Generating resources from generate.json

t-rex generate

The generate command creates resources depending on the contents of generate.json.
Format of generate.json:

// generate.json
{
  "resources": {
    "<resource_name>": {
      "socket": <boolean>,
      "methods": [<GET/POST/PUT/DELETE>],
      "attributes": {
        "<attribute>": "<sequelize_data_type>",
        ...
      }
    },
    ...
  }
}

Contact Details

Name: Levy V. Medina II
Email: [e-mail]
Mobile: [phone]