Experimental multi site Approved-by: Dorian Pula <dorian.pula@amber-penguin-software.ca> |
||
---|---|---|
.circleci | ||
docs | ||
rookeries | ||
scripts | ||
src | ||
static | ||
tasks | ||
templates | ||
tests | ||
.babelrc | ||
.docker-repository.yml | ||
.dockerignore | ||
.eslintrc.json | ||
.gitignore | ||
Dockerfile | ||
Makefile | ||
Pipfile | ||
Pipfile.lock | ||
docker-compose.yml | ||
package.json | ||
readme.md | ||
requirements.txt | ||
webpack.config.js | ||
yarn.lock |
readme.md
Rookeries
A developer and designer friendly web platform for building gorgeous sites, blogs and portfolios.
Rookeries is:
- Powered by Flask, Python and PostgreSQL on the server side.
- Uses preact, redux, ES2017 and webpack to build responsive single page apps.
- Licensed under the Affero GNU General Public License (AGPL) version 3.0.
Build Status:
Installation
Rookeries is heavily under development and once things stabilize there will be a user friendly installation guide. In the meantime, please refer to the development guide below.
Development
Rookeries uses the following technologies:
- Python 3.6
- NodeJS 8 + ES2017
- PostgreSQL 9.6
- Docker + docker-compose
Getting Started
Rookeries requires newer versions of Docker (<1.9.0) and docker-compose (<1.8.0).
- Install docker-compose
- Build Rookeries:
make build
- Run tests:
make test
make test-api
to run API server tests.make test-ui
to run UI tests.
- Run demo:
make demo
- Run the invoke scripts on a running Rookeries container with:
docker-compose exec rookeries inv $MY_TASK
- Use
inv -l
to list the available invoke tasks.
- Use
- When running the demo, navigate to the main Rookeries page in a browser: http://localhost:5000/