Oakadmin NPM | npm.io

OaktreeApps Admin CLI

About

This is a simple CLI application to quickly setup MERN stack admin project with Express backend & React frontend.

The CLI allows you to create resources at the frontend and corresponding routes & models at the backend with one command.

Everything is controlled in the kitconfig folder.

Installation

To install the CLI application, run the following command:

npm i -g oakadmin

And then to run the CLI application, run the following command:

oakadmin [commands...]

Or you can run the CLI application directly via npx:

npx oakadmin [commands...]

Commands

`scaffold [...options] project-name`

Creates a new admin project containing the following folders:

kitconfig - folder containing the .cjs files for configuring the project (also comes with sample files resources/products.cjs & resources/students.cjs).
webapp - React.js project containing the UI components (styled UI components & theme provided by PrimeReact).
server - Express.js (TypeScript) project hooked up to MongoDB database.

Usage

npx oakadmin scaffold admin-panel

npx oakadmin scaffold --only-webapp admin-panel

npx oakadmin scaffold --only-server admin-panel

`addconfig resourcename`

Creates a .cjs config file for the resource to be added in project's kitconfig folder.

This file contains the properties & fields that the resource needs.

Usage

npx oakadmin addconfig products

It can be edited to add fields & properties describing backend & frontend requirements.

`add`

Creates UI & corresponding backend (models, routes & controllers).

Usage

Displays a menu of all the resources present in kitconfig/resources folder.

Adds the selected resources to webapp & server.

npx oakadmin add

npx oakadmin add --all

`remove`

Displays a menu of all the resources present in kitconfig/resources folder.

Removes the selected resources from webapp & server.

Only removes the resource(s) from codebase, won't remove the config file.

Usage

npx oakadmin remove

npx oakadmin remove --all

.env files

Frontend

The .env file in the frontend folder expects only 1 variable i.e. base url of the corresponding backend server.

VITE_BASE_URL = "http://localhost:3005/api"

Backend

The .env file in the backend folder expects various variables, here's a sample .env file that goes with the server.

REST_API_PORT=3005 #REQUIRED
MONGO_CONNECTION_URL=mongodb+srv://<username>:<password>@cluster.mongodb.net/?retryWrites=true&w=majority #REQUIRED


AUTH_PRIVATE_BASE64= #REQUIRED
AUTH_PUBLIC_BASE64= #REQUIRED

SMTP_HOST=
SMTP_PORT=
SMTP_USER=
SMTP_PASSWORD=
SMTP_FROM_EMAIL=
SMTP_FROM_NAME=

S3_REGION=
S3_ACCESS_KEY=
S3_ACCESS_ID=
S3_BUCKET_NAME=

STATIC_S3_REGION=
STATIC_S3_BUCKET_NAME=

Kit Config

Folder Structure

  |-kitconfig
    |-resources
      |-resource1.cjs
      |-resource2.cjs
      ...
    |-types.d.ts

  |-webapp
  |-backend

The kitconfig/resources folder contains the .cjs files for configuring the project.

The kitconfig/types.d.ts file contains the types for the resource JS object defined in the kitconfig/resources/resource.cjs folder.

`resource.cjs`

Here's a sample file that covers all the properties & fields that can be defined in the resource config file.

/**
 * @type {import('../types').Resource}
 */
const resource = {
  name: "Students",
  url: "/students",
  collectionName: "students",
  crudFields: [
    { name: "fullName", datatype: "String", widget: "InputText" },
    { name: "bio", datatype: "String", widget: "InputTextarea", required: false },
    { name: "password", datatype: "String", widget: "InputText", tableDisplay: false },
    { name: "rollNo", datatype: "Number", widget: "InputNumber", inline: true, unique: true },
    {
      name: "city",
      datatype: "String",
      widget: "Dropdown",
      inline: true,
      options: [
        { name: "New York", value: "NY" },
        { name: "Rome", value: "RM" },
        { name: "London", value: "LDN" },
        { name: "Istanbul", value: "IST" },
        { name: "Paris", value: "PRS" },
      ],
    },
    { name: "isPublic", widget: "InputSwitch", datatype: "Boolean" },
    {
      name: "gender",
      datatype: "String",
      widget: "RadioButton",
      options: [
        { name: "Male", value: "M" },
        { name: "Female", value: "F" },
        { name: "Other", value: "O" },
      ],
    },
  ],
};

module.exports = resource;

Quick note: The boilerplate containing name, collectionName & url can be generated with addconfig resourcename command

For the resource object, the following properties are supported:

name (required) - name of the resource
url (required) - url of the resource where the resource data will be available in the admin panel UI
collectionName (required) - name of the collection in the MongoDB database
crudFields (required) - the fields that the resource needs defined in an array of objects (refer below for more info)

For the crudFields property, the following properties are supported:

name (required) - name of the field
datatype (required, optional if widget is given) - the datatype of the field - is of type: String, Number or Boolean
widget (required, optional if datatype is given) - the widget name to be used for the field - is of type: InputText, InputNumber, InputTextarea, InputSwitch, Dropdown or RadioButton
options - the options for the field (for dropdown, radio button, etc.) - is of type: [{ name: string, value: string }, ...]
unique (optional, default = false) - whether the field is unique or not - is of type: true or false
required (optional, default = true) - whether the field is required or not - is of type: true or false
tableDisplay (optional) - whether the field should be displayed in the table or not: is of type: true or false
inline (optional, default = false) - consecutive fields marked as inline are grouped and displayed in a row in UI - is of type: true or false