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.
812 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 eb58c5b1f6 Add test randomization to flesh out tests. 2017-03-08 21:54:25 -05:00
api Add test randomization to flesh out tests. 2017-03-08 21:54:25 -05:00
scripts Fix where git info from container gets stored. 2017-03-08 08:26:38 -05:00
webapp Release version 0.6.1 as a quick hotfix to version numbers. 2017-03-07 23:10:04 -05:00
.docker-repository.yml Add Docker Hub plugin notification to rookeries. 2016-11-03 08:33:18 -04:00
.gitignore Add git revision to the status endpoint. 2017-03-07 15:53:09 -05:00
Makefile Remove manually past in DB connection. 2017-03-08 21:08:29 -05:00
circle.yml Merge API tests into a single command and category. 2017-02-26 23:26:49 -05:00
docker-compose.yml Bring DB connection into API testing setup, to prep migration away from sample site fixture setup. 2017-02-28 08:10:52 -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/