Installation

Using the package manager npm to install Simple Js.

npm install -g simple-js-framework

Basic Usage

To create a Simple Js project just type in the command line:

simplejs create -t=project -n=project-name

To start using the Simple Js environment:

cd project-name
npm start
npm test

Next open the browser in http://localhost:9898

The Simple Js live server is powered by Nodemon.

Creating Components

A component is another instance of javascript within the same project.

Create a new component is very simple, just run the following command from the project root:

simplejs create -t=component -n=component-name

The component will be available on the route http://localhost:9898/component-name

Environment

The environment structure is simple, just look at it:

.
├── public                          # Public page files
|   ├── css                         # CSS files
|   │   └── app.css                 # Principal project css file
│   ├── images                      # Image files
│   ├── js                          # JS files
|   │   ├── app.js                  # Principal project js file
|   │   ├── authentication.js       # Authentication js file
|   │   ├── globals.js              # Component global variables file
|   │   └── pages.js                # Component pages declaration file
│   └── index.html                  # Principal index.html file
├── res                             # Multilanguage support files
│   ├── en.json                     # English texts file
|   └── es.json                     # Spanish texts file
├── src                             # Virtual server environment files
│   ├──conf                         # Server configuration files
|   │   ├── component.json          # Frontend component list
|   │   └── static.json             # Static file path list
|   └── server.js                   # Principal server side file
├── .env                            # Environment variables file
└── package.json                    # Project package file

Frontend

The Simple Js default frontend is powered by Bootstrap 4.6.0.

Virtual Server

The Simple Js virtual server structure is powered by:

express, cors, dotenv, helmet, morgan

Contributors

.
└── Johangel Ilarraza

License

This framework is under the ISC license.