Skip to content

Latest commit

 

History

History
51 lines (37 loc) · 1.78 KB

README.md

File metadata and controls

51 lines (37 loc) · 1.78 KB

Vulkano Zero

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

Stack

System Requirements

  • Unix
  • Node.js v20+

Quick start

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