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.
641 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 f41e816732 Remove unused import for pexpect. 2016-11-06 23:26:27 -05:00
api Remove unused import for pexpect. 2016-11-06 23:26:27 -05:00
webapp Merge branch 'master' into enable-feature-tests 2016-11-06 21:47:55 -05:00
.docker-repository.yml Add Docker Hub plugin notification to rookeries. 2016-11-03 08:33:18 -04:00
.gitignore Add support for SauceLabs connect. 2016-10-28 12:45:24 -04:00
Rotefile Clean up functional test setup. 2016-11-06 21:44:53 -05:00
circle.yml Workaround if builds break during creation of Docker images. 2016-11-06 23:14:25 -05:00
docker-compose.yml Revert to older working CouchDB. 2016-11-05 09:10:55 -04:00
license.md Update documentation on the purpose of Rookeries. 2015-09-03 13:31:52 -04:00
readme.md Revert to older working CouchDB. 2016-11-05 09:10:55 -04:00
rote Move rote utility up to top-level. 2016-10-23 17:32:29 -04: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 CouchDB 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

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:

Getting Started

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

  1. Install docker-compose
  2. Build Rookeries: ./rote build
  3. Run tests: ./rote test
  4. Run demo: ./rote 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/