Miscellaneous Info

Documentation has moved.

The documentation for Flitter has moved. You probably want to be here: https://flitter.glmdev.tech/

Error Philosophy

When errors occur in Flitter, be they code or user, they should be handled and passed up to the next highest level so as to be as non-disruptive and transparent as possible. Errors should be handled as appropriate at the lowest level possible. For example, server errors that don't affect the user should not disrupt the request-response flow, but should be logged in the console. If a sub-process of a controller fails, an error should be shown to the user, but the request shouldn't fail to send.

Bug Reports & Security Issues

Found a bug in Flitter? Please let me know! I'll try to get them fixed as soon as possible. You can file general bug reports as issues in the respective Gitea repositories here. If you're not sure which package to file your report under, just put it in the main Flitter repository. Flitter is libre, so any contributions are welcome!

Security bugs should be reported to security@glmdev.tech.

Releases

Flitter's sub-components are semantically versioned. This means that, beyond version 1.0.0, all releases of the same major release number are backwards-compatible. This documentation defines the public API of said components.

The main Flitter framework is developed with a different philosophy. Occasional versioned releases may be made, but to the best of my ability, the master branch of the Flitter repository should always have the most up-to-date working version of the framework. I always push a yarn.lock file with the framework that specifies the exact versions of the packages I was running.

NPM? Yarn.

I prefer Yarn as opposed to the Node Package Manager. It's effectively the same, but it works more reliably for me, and has little niceties that I prefer. As such, I use Yarn when developing Flitter. That means that, while you can install Flitter's packages with NPM, you won't have the benefit of a lock file. If you install packages with Yarn, you'll get the exact versions I had when I pushed the working framework.

Flitter, and any sub-components developed by me are Copyright © 2019 Garrett Mills.

Flitter and the aforementioned sub-components are released under the terms of the MIT license. They are subject to all terms within that license, available here. However, the MIT license is very permissive, which means you can basically use Flitter however you want, with no warranty provided by me, nor can I be held liable for their employment.


Revision #2
Created Sat, Mar 9, 2019 1:09 AM by Garrett Mills
Updated Fri, Apr 19, 2019 12:58 PM by Garrett Mills