Nodea is a computer aided software that enable to generate Node.js applications by giving instructions to a bot.
Official website: https://nodea-software.com
Official documentation: https://docs.nodea-software.com
Node.js LTS / Fermium (v14 or later)
Default: MariaDB (v10.3 or higher)
Optional: MySQL (8 or higher) / PostgreSQL
git clone:
git clone git@github.com:nodea-software/nodea.git
Execute the following instructions:
cd nodea chmod +x install.sh bash install.sh
If it does not work then follow these steps:
Use .sql file that are in sql/ directory to generate the database, there are 3 files for each available dialect (MariaDB, MySQL, Postgres)
Note that MariaDB is the default dialect, if you want to change please update the dialect key in config/database and structure/template/config/database.js
If you want to access your generator by localhost:1337 instead of 127.0.0.1:1337 please update the host key in config/global.js
Note that if you access the generator with localhost and let the host key to 127.0.0.1 you'll have cookie mismatch and you will often be logged out of generated applications inside the generator
Install node modules
npm install --no-optional
You can remove the --no-optional if you also want to install Cypress.
Follow the instructions and wait for message :
Nodea ready to be started -> node server.js
Then, execute command line :
node server.js
Open your browser on:
http://127.0.0.1:1337
Set your password on the first connection page:
http://127.0.0.1:1337/first_connection?login=admin&email:admin@local.fr
The default generator login is: admin
The default generator email is: admin@local.fr
Note : to generate your first application, ports 9000 and 9001 must be available on your computer.
Docker and Docker compose installed
Create (and adapt if necessary) "docker-compose.yml" file:
version: '3.3'
services:
nodea:
container_name: nodea_app
image: nodeasoftware/nodea:latest
ports:
- "1337:1337"
- "9001-9025:9001-9025" # 25 applications max, you can increase to 9100 for 100 applications if necessary
networks:
- nodea_network
volumes:
- workspace:/nodea/workspace
environment:
NODEA_ENV: "develop"
HOSTNAME: "127.0.0.1"
SERVER_IP: "127.0.0.1"
DATABASE_IP: "database"
DATABASE_USER: "nodea"
DATABASE_PWD: "nodea"
DATABASE_NAME: "nodea"
database:
container_name: nodea_database
image: nodeasoftware/nodea-database-mariadb:latest # nodea-database-mysql || nodea-database-mariadb || nodea-database-postgres
networks:
- nodea_network
volumes:
- db_data:/var/lib/mysql
environment:
MYSQL_ROOT_PASSWORD: nodea
MYSQL_DATABASE: nodea
MYSQL_USER: nodea
MYSQL_PASSWORD: nodea
networks:
nodea_network:
volumes:
db_data:
workspace:
Execute Docker compose command:
sudo docker-compose up -d
Wait about 30 seconds and open your browser on:
http://127.0.0.1:1337
Set your password on the first connection page:
http://127.0.0.1:1337/first_connection?login=admin&email:admin@local.fr
The default generator login is: admin
The default generator email is: admin@local.fr
Note: to set up Nodea docker containers, range ports 9001 to 9025 must be available on your computer.
Nodea Software documentation is available at : https://docs.nodea-software.com
Nodea is released under the GNU GPL v3.0 license. It contains several open source components distributed under the MIT, BSD or GNU GPL V3.0 licenses.