rookeries
/
rookeries
1
0
Fork 0
Code Issues 11 Pull Requests Projects Releases Wiki Activity
rookeries/readme.md

60 lines
2.3 KiB
Markdown
Raw Normal View History

Update documentation on the purpose of Rookeries. Transform license into a more Markdown friendly version. Remove old documentation and unneeded Nose config.
2015-09-03 13:31:52 -04:00
# Rookeries
Update documentation about using CouchDB instead of PostgreSQL.
2017-10-25 01:00:28 -04:00
A developer and designer friendly CMS for building gorgeous micro-sites,
blogs and portfolios.
Update documentation on the purpose of Rookeries. Transform license into a more Markdown friendly version. Remove old documentation and unneeded Nose config.
2015-09-03 13:31:52 -04:00
**Rookeries** is:
Update documentation in README.
2018-08-08 16:42:22 -04:00
- Powered by Rust and CouchDB on the server side.
Update the readme.
2017-11-02 09:19:23 -04:00
- Uses preact, mobx, ES2017 and webpack to build responsive single page apps.
Add documentation to setting up, installing and running Rookeries locally.
2016-04-09 08:55:14 -04:00
- Licensed under the Affero GNU General Public License (AGPL) version 3.0.
Update documentation on the purpose of Rookeries. Transform license into a more Markdown friendly version. Remove old documentation and unneeded Nose config.
2015-09-03 13:31:52 -04:00
Update the README some more and fix the builds.
2016-10-25 17:47:05 -04:00
## Build Status:
Update documentation on the purpose of Rookeries. Transform license into a more Markdown friendly version. Remove old documentation and unneeded Nose config.
2015-09-03 13:31:52 -04:00
Fix README badges.
2016-12-16 23:13:53 -05:00
- **CircleCI**: [![CircleCI](https://circleci.com/bb/dorianpula/rookeries.svg?style=svg)](https://circleci.com/bb/dorianpula/rookeries "CircleCI builds")
Update documentation and links to show a single container.
2017-03-15 11:15:52 -04:00
- **Docker**:
[![](https://img.shields.io/docker/automated/dorianpula/rookeries.svg)](https://hub.docker.com/r/dorianpula/rookeries/ "Docker Hub")
[![](https://img.shields.io/docker/pulls/dorianpula/rookeries.svg)](https://hub.docker.com/r/dorianpula/rookeries/ "Docker Hub")
[![](https://img.shields.io/docker/stars/dorianpula/rookeries.svg)](https://hub.docker.com/r/dorianpula/rookeries/ "Docker Hub")
[![](https://images.microbadger.com/badges/image/dorianpula/rookeries.svg)](https://microbadger.com/images/dorianpula/rookeries "Rookeries Docker size courtesy of microbadger.com")
Add documentation to setting up, installing and running Rookeries locally.
2016-04-09 08:55:14 -04:00
## Installation
Update documentation about using CouchDB instead of PostgreSQL.
2017-10-25 01:00:28 -04:00
*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.
Add documentation to setting up, installing and running Rookeries locally.
2016-04-09 08:55:14 -04:00
## Development
*Rookeries* uses the following technologies:
Update documentation in README.
2018-08-08 16:42:22 -04:00
- Rust 1.27+
Update documentation and readme.
2017-09-24 14:16:17 -04:00
- Python 3.6
Update documentation in README.
2018-08-08 16:42:22 -04:00
- NodeJS 10 + ES2017
Update documentation about using CouchDB instead of PostgreSQL.
2017-10-25 01:00:28 -04:00
- CouchDB 2x
Remove vagrant and frontend tasks from API service. Update the README.
2016-10-25 17:42:56 -04:00
- Docker + docker-compose
Add documentation to setting up, installing and running Rookeries locally.
2016-04-09 08:55:14 -04:00
### Getting Started
Update documentation about using CouchDB instead of PostgreSQL.
2017-10-25 01:00:28 -04:00
**Rookeries** requires newer versions of Docker (<1.9.0) and
docker-compose (<1.8.0).
Add documentation to setting up, installing and running Rookeries locally.
2016-04-09 08:55:14 -04:00
Update the README some more and fix the builds.
2016-10-25 17:47:05 -04:00
1. [Install docker-compose](https://docs.docker.com/compose/install/)
Remove Rote based build setup, update docs and remove need for storing saucelabs assets in the home directory.
2016-12-16 21:34:20 -05:00
1. Build Rookeries: `make build`
1. Run tests: `make test`
Add support to visually debug tests.
2017-03-27 08:47:15 -04:00
- `make test-api` to run API server tests.
- `make test-ui` to run UI tests.
Remove Rote based build setup, update docs and remove need for storing saucelabs assets in the home directory.
2016-12-16 21:34:20 -05:00
1. Run demo: `make demo`
Update documentation about using CouchDB instead of PostgreSQL.
2017-10-25 01:00:28 -04:00
1. Run the invoke scripts on a running Rookeries container with:
`docker-compose exec rookeries inv $MY_TASK`
Update the README some more and fix the builds.
2016-10-25 17:47:05 -04:00
- Use `inv -l` to list the available invoke tasks.
Update documentation about using CouchDB instead of PostgreSQL.
2017-10-25 01:00:28 -04:00
1. When running the demo, navigate to the main Rookeries page in a browser:
[http://localhost:5000/](http://localhost:5000/)
Add support to visually debug tests.
2017-03-27 08:47:15 -04:00
Update the readme.
2017-11-02 09:19:23 -04:00
Please refer to the [Development Notes](docs/devnotes.md) for more details.
Keep dev environment variables together in a single place.
2018-08-12 00:04:35 -04:00
### Local Server Setup
To run the Rust server locally, remember to initialize the local dev environment
variables using: `export $(cat dev.env | xargs)`