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 62c818dc8d
Add ability to require e-mail verification
7 days ago
app Add ability to require e-mail verification 7 days ago
config Add ability to require e-mail verification 7 days ago
flaps Initial Flitter Commit 1 year ago
locale Add ability to require e-mail verification 7 days ago
tmp.uploads Add support for profile photos; default image 12 months ago
uploads Initial Flitter Commit 1 year ago
.drone.yml Update drone to use promotions for prod 5 months ago
.gitignore Add support for profile photos; default image 12 months ago
LICENSE Initial Flitter Commit 1 year ago
README.md Initial Flitter Commit 1 year ago
TODO.txt Expand activity tracking and add PasswordResetAlert job 10 months ago
Units.flitter.js add support for Gotify push notifications 8 months ago
docker-compose.yml Initial Flitter Commit 1 year ago
docker.env Initial Flitter Commit 1 year ago
example.env Update flitter jobs 5 months ago
flaps.json Initial Flitter Commit 1 year ago
flitter Flesh out users OU (works with Gitea simple LDAP now!!) 1 year ago
index.js Flesh out users OU (works with Gitea simple LDAP now!!) 1 year ago
package.json Update libflitter 3 weeks ago
yarn.lock Update libflitter 3 weeks 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 for routing
  • Mongoose for ODM
  • Busboy for request 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.

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 © 2019 Garrett Mills. ;)

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