Skip to content
Azarattum edited this page Nov 24, 2020 · 11 revisions

Welcome to the TheFramework wiki!

Introduction

The main idea behind TheFramework is to bring similar workflow to front-end and back-end developments. Both node and browser branches have the same core from the base branch. Therefor TheFramework empowers its users to make great full-stack apps without doubling the learning curve.

Another significant difference from the majority of frameworks is that the library and boilerplate are the same thing. TheFramework aims to bring install-and-use environment to any of your projects as it bundles all the configurations, custom loaders and file structure with its core. It makes TF almost a zero-configuration framework. This also allows you to change framework core functionality adapting it to any of you projects without messing with node modules. Another benefit of this approach is the consistency that it brings to derived projects, because of roughly the same environment setup which is only modified on as-needed basis.

Quick Start

To start using TheFramework you just need to clone this GitHub repository with

git clone https://github.com/Azarattum/TheFramework
cd TheFramework

After cloning you need to choose the environment your project is going to be in by switching to an appropriate branch

git checkout browser

or

git checkout node

As TheFramework has some development dependencies you need to install them with npm

npm install

Now optionally you can delete git data as you will probably have your own repository setup

rm -rf .git

Now you are ready to build your awesome applications! Check out the rest of the documentation to find out how. Or just straight to the example.