Vulkano Zero

Vulkano Zero is a small, simple, and fast framework for creating web applications using NodeJS.

Stack

• Node.js
• Express
• Mongoose
• Nunjucks (Template Engine)
• Nodemon (Reload automatically for dev mode)
• PM2 (Deployment)
• BrowserSync (Time-saving synchronised browser testing)
• WebPack (Bundle your scripts)

System Requirements

• Unix
• Node.js v20+

Quick start

• Clone from https://github.com/vulkanojs/vulkano-zero
• Run npm install as usual to install dependencies
• Run npm run dev to start working

NPM preset tasks

Command	Description
npm run dev	Run development server and watch changes
npm run start	Start server
npm run webpack	Start webpack (js, sass, and browsersync)
npm run build	Task to buils assets in production mode

Usage with Docker

• Run docker compose -f "docker-compose-prod.yml" up -d --build to execute the production configuration.
• Run docker compose up to execute the development configuration, watch for changes, etc.

Project Structure

• app/ - Your backend application
• client/ - Your JS and CSS sources
• core/ - Vulkano Zero heart (hack it if you want)
• public/ - HTTP Public folder. Compiled assets goes here too.
• Procfile - Heroku entry point
• README.md - This file
• app.js - Server entry point
• nodemon.json - Nodemon configuration file