Takeoff: Rapid Prototyping Environment
Takeoff is a toolbox for rapid prototyping applications.
It is not a framework and is in fact agnostic to any solutions provided to it. However to provide the ability to rapidly develop applications it ships with some opinionated defaults.
Under the hood is uses
docker-compose to minimise the hassle out of setting up frontend, backend and database servers. Within seconds you'll have a hot-reloading frontend and backend which allows you to make changes without the need to usually restart the server.
The default configuration ships with:
- A plugin-based API server powered by Hapi
- A hot-reloading React frontend including React Router v4 and Redux
- A Postgres database and a Sequelize adapter available in the API to interact with it
- A Ngnix server proxying all requests via port 80.
With the API you also get out of the box user management and authentication, and on the frontend a default login page and API middlware to use a JSON Web Token (JWT) to provide authenticated access for your endpoints with
user scopes available . Using the documentation to can then extend these with your own functionality.
There are a set of available commands to help make the toolbox cross-platform. These are in the process of being integrated and documented.
Currently only Linux is fully tested and supported out the box, but support for other OS is coming (testers and contributors welcome!). There is a page for Windows Users to provide extra information in the quest to get it working.
How to get started
This software has currently only been tested on Linux using Docker Community Edition. Once installed you will have the
Installing takeoff is done in 4 easy steps. Remember you can also clone the repository first to make it easier to manage your own copy.
> git clone https://github.com/tanepiper/takeoff.git > cd takeoff > npm install > npm start
The above commands will install all the dependencies and have you up and running in minutes.
The default user is
admin and password is
password. Do not expect this to be a fully secure environment.
Disclaimer: If you build an app with this you wish you deploy, you are responsible for your own security.
You will find several folders and files:
-| |- api # This is the Hapi API Server |- app # This is the frontend app |- docker # This is where all the docker configurations are kept |- docs # Docs folder, for Github Pages |- nginx # Nginx configuration |- scripts # Scripts, will be deprecated due to only supporting linux |- utilities # Will replace scripts |- README.md # The file you are looking at!
Inside the docker folder and several docker files which create the environments.
The default environments are listed below with the main environments from their docker files. Full components will be listed soon.
|api||node||8.4.0||Hapi-powered API that comes pre-build with a user and authentication plugin, uses nodemon for changes.|
|app||node||8.4.0||Webpack/React app that is hot-reloaded on changes|
Run via docker compose, you can begin to add plugins to the Hapi server. You can easily add your own docker images for other services such as redis, memcache, mysql, etc.
- This document environment was based on the tutorial Dockerize your app and keep hot-reloading ! but adding more utilities and making it easier to work as a starter kit.
- Blog post announcing Takeoff
- Logo made with LogoMakr
- Provide other hot loading frontend frameworks (Angular, Vue)
- Improve dashboard of main app
- Provide more built in plugins and apps