rookeries
/
rookeries
1
0
Fork 0
Code Issues 11 Pull Requests Projects Releases Wiki Activity
A developer and designer friendly web platform for building gorgeous sites, blogs and portfolios.
765 Commits 6 Branches 20 Tags 44 MiB
Rust 59.9%
JavaScript 21.1%
CSS 7.9%
Shell 4.9%
Dockerfile 3.2%
Other 3%
Go to file
Dorian fe42964dd2 Update functional tests. 2017-02-25 16:51:39 -05:00
api Update functional tests. 2017-02-25 16:51:39 -05:00
scripts Workaround error in CircleCI builds. 2017-01-31 14:12:11 -05:00
webapp Fix issues found by linter. 2016-11-24 07:33:22 -05:00
.docker-repository.yml Add Docker Hub plugin notification to rookeries. 2016-11-03 08:33:18 -04:00
.gitignore Convert docker image commands into a standalone script. 2016-12-14 22:57:54 -05:00
Makefile Workaround issues with CircleCI btrfs volume issues. 2017-02-25 12:25:31 -05:00
circle.yml Attempt to work around CircleCI issues by upgrading docker-compose. 2017-02-25 11:51:53 -05:00
docker-compose.yml Remove external database port from docker-compose. 2017-02-24 23:29:08 -05:00
license.md Update documentation on the purpose of Rookeries. 2015-09-03 13:31:52 -04:00
readme.md Fix README badges. 2016-12-16 23:16:16 -05:00

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 React, Redux, ES6 and LESS to build responsive single page apps.
  • Licensed under the Affero GNU General Public License (AGPL) version 3.0.

Build Status:

  • CircleCI: CircleCI
  • Docker (API):
  • Docker (Webapp): )

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 2.7
  • NodeJS 6.9 + ES6
  • PostgreSQL 9.6
  • Docker + docker-compose
  • Make

Getting Started

Rookeries requires newer versions of Docker (<1.6.0) and docker-compose (<1.5.0).

  1. Install docker-compose
  2. Build Rookeries: make build
  3. Run tests: make test
  4. Run demo: make demo
  5. Run the invoke scripts on the API container with: docker-compose exec api inv $MY_TASK
    • Use inv -l to list the available invoke tasks.
  6. Run the npm scripts on the webapp container with: docker-compose exec webapp npm run $MY_TASK
  7. When running the demo, navigate to the main Rookeries page in a browser: http://localhost:5000/