Skip to content

Lazycoder229/FeatherMVC-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

FeatherMVC-v1.0

Experience a modern, lightweight MVC framework powered by Express, MySQL, and pure HTML/CSS/Tailwind/JavaScript.

FeatherMVC-Express

Minimal MVC framework on Node.js (Express) + MySQL with plain HTML/CSS/JS.

Requirements

  • Node.js 18+
  • MySQL 8+ (or MariaDB)

Installation

npm install
cp .env.example .env
# edit .env with your DB credentials

Commands

Start development server

feather run dev

Starts with nodemon so it restarts on file changes.

Start production server

feather start

Run migrations

feather run migrate

CLI (Scaffolding)

feather run cli -- <command> <Name>

Commands:

FeatherMVC CLI Commands:

  • make:page <name>Create HTML page, controller, route, and auto-register
  • make:controllerCreate only a controller -make:modelCreate a model -make:routeCreate a route -helpShow this help message

Example:

feather make:page blog


Add a new package

npm install package-name

Or for dev dependency:

npm install -D package-name

Project Structure

myapp/
├─ bin/                # CLI scripts
├─ db/                 # migrations and runner
├─ public/             # static assets
├─ src/
│  ├─ config/          # DB config
│  ├─ controllers/     # request handlers
│  ├─ lib/             # view engine
│  ├─ middleware/      # custom middleware
│  ├─ models/          # DB models
│  ├─ routes/          # route definitions
│  ├─ views/           # layouts and pages
│  └─ server.js        # app entry
└─ .env.example        # environment template

First Run

npm install
cp .env.example .env
# edit .env for DB settings
npm run migrate
npm run dev
# visit http://localhost:3000

About

A documentation for Feather MVC

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published