@safidea_/engine
v0.9.0
Published
Generate web app with a configuration file
Downloads
686
Readme
Safidea Engine - Web App Generator
Safidea Engine is a API to generate web app, fast and easy. With a configuration file, you can create a full stack application.
Getting Started
Pre-requisites
You should have Node.js 20.11.1 or higher installed on your machine.
Installation
In a node project, install the engine with npm:
npm install @safidea_/engine
Usage
Then, create a startup file, for example index.js
:
import App from '@safidea_/engine'
const app = new App()
const url = await app.start({
name: 'Hello world website',
features: [
{
name: 'website',
pages: [
{
name: 'home',
path: '/',
body: [
{
component: 'Title',
text: 'Hello world!',
},
],
},
],
},
],
})
console.log(`Server started at ${url}`)
Finally, run the startup file with node:
node index.js
Configuration
A configuration is a JSON representation of the application. It contains the pages, the tables, the automations, the roles, etc...
We will build a details documentation of the configuration in the future, but for now, you can see the examples to see how to configure the engine.
App Library
Contributing
Safidea Engine is built and maintained by a small team – we'd love your help to fix bugs and add features!
You can read our contributing guide here and our code of conduct here.
License
Safidea Engine is BSL 1.1 licensed.