Flitter is a quick & lightweight web application framework.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Garrett Mills 63a7b04078 Update 'README.md' 3 weeks ago
app Add flitter-i18n; update dependencies 1 month ago
config Add flitter-i18n; update dependencies 1 month ago
flaps Update libflitter and refresh general files 2 months ago
locale Add flitter-i18n; update dependencies 1 month ago
tmp.uploads Update import style; fix uploads config 1 month ago
uploads update libflitter 1 year ago
.gitignore initial 1 year ago
LICENSE Update libflitter and refresh general files 2 months ago
README.md Update 'README.md' 3 weeks ago
Units.flitter.js Add flitter-i18n; update dependencies 1 month ago
docker-compose.yml build: upgrade dependencies and run flap migrations 1 year ago
docker.env Update libflitter and refresh general files 2 months ago
example.env Update libflitter and refresh general files 2 months ago
flaps.json upgrade dependencies and run migrations 10 months ago
flitter Update libflitter; add RLEH 2 months ago
index.js Update libflitter; add RLEH 2 months ago
package.json Add flitter-i18n; update dependencies 1 month ago
yarn.lock Add flitter-i18n; update dependencies 1 month ago

README.md

Flitter

Flitter is a quick & ligthweight web app framework based on Express.

What?

Flitter is an MVC style framework that aims to get you up and running faster by providing a structure and a wrapper for Express.js. Files in predictable directories are parsed into routes, middleware, controllers, models, and views.

Flitter provides access to the Express app, while making it possible to create an app without needing to piece together the Express framework.

Flitter Provides:

  • Express at its core
    • Segmented routing, middleware, and controllers
  • Busboy for request body parsing
  • Favicon support
  • ./flitter - CLI tools for Flitter (including an interactive shell)
  • User auth & sessions (see below)

How?

Getting started with Flitter is easy. To create a new project, simply run the following commands:

# Download Flitter:
git clone https://git.glmdev.tech/flitter/flitter {project_name}
cd {project_name}

# Install dependencies:
yarn install

# Create default config:
cp example.env .env

# Launch Flitter!
node index.js

# Or use the interactive shell
./flitter shell

And voilà! You should have a Flitter app up and running on port 8000 by default. You can find a more in-depth getting started guide in the documentation.

Why?

Flitter’s creator is a former Laravel junkie, but loves Node and Express. He got tired of having to hammer out the same 500 lines of code to start every project, but didn’t want the bulk and obfuscation of larger frameworks like AdonisJS.

Flitter is designed to be compartmentalized and easy to understand. Every piece of its core functionality is broken into “units.” Each of these units does some task like loading config, parsing middleware, connecting to the database, etc. You can see exactly what units your application is loading by viewing the Units file in config/Units.flitter.js. Each of Flitters core units are open to view in the libflitter package.

Of course, this also means that Flitter is extremely easy to extend. If you want to add a custom package, simply require it and add its unit to the Units file!

Who?

Flitter was created by Garrett Mills, and its use is governed by the terms of the MIT License as specified in the LICENSE file.

Of course, that does mean that Flitter is © 2020 Garrett Mills. ;)

This command will copy the necessary files to your Flitter install. The files are directly accessible and, therefore, completely customizable.