compose/README.md

76 lines
2.5 KiB
Markdown
Raw Normal View History

2014-01-11 15:17:00 +01:00
Fig
===
[![Build Status](https://travis-ci.org/orchardup/fig.png?branch=master)](https://travis-ci.org/orchardup/fig)
2014-01-20 19:41:04 +01:00
[![PyPI version](https://badge.fury.io/py/fig.png)](http://badge.fury.io/py/fig)
2013-12-09 13:01:15 +01:00
2014-01-27 16:54:43 +01:00
Fast, isolated development environments using Docker.
2013-12-09 22:50:36 +01:00
2014-01-27 19:18:53 +01:00
Define your app's environment with Docker so it can be reproduced anywhere:
2014-01-27 16:54:43 +01:00
FROM orchardup/python:2.7
ADD . /code
WORKDIR /code
2014-01-28 01:07:59 +01:00
RUN pip install -r requirements.txt
2014-01-27 16:54:43 +01:00
CMD python app.py
2014-01-27 21:04:48 +01:00
Define the services that make up your app so they can be run together in an isolated environment:
2013-12-09 13:01:15 +01:00
```yaml
web:
build: .
links:
- db
ports:
- "8000:8000"
- "49100:22"
2013-12-09 13:03:26 +01:00
db:
image: orchardup/postgresql
2013-12-09 13:01:15 +01:00
```
2014-01-27 19:18:53 +01:00
(No more installing Postgres on your laptop!)
2014-01-02 15:55:48 +01:00
Then type `fig up`, and Fig will start and run your entire app:
2014-01-14 20:19:15 +01:00
![example fig run](https://orchardup.com/static/images/fig-example-large.f96065fc9e22.gif)
2013-12-31 17:31:40 +01:00
There are commands to:
- start, stop and rebuild services
- view the status of running services
- tail running services' log output
- run a one-off command on a service
2014-02-28 19:56:30 +01:00
Fig is a project from [Orchard](https://orchardup.com), a Docker hosting service. [Follow us on Twitter](https://twitter.com/orchardup) to keep up to date with Fig and other Docker news.
2014-01-02 15:55:48 +01:00
2014-01-27 19:11:27 +01:00
Installation and documentation
------------------------------
2014-01-02 15:55:48 +01:00
2014-01-27 19:11:27 +01:00
Full documentation is available on [Fig's website](http://orchardup.github.io/fig/).
2013-12-09 13:01:15 +01:00
2014-01-27 19:11:27 +01:00
Running the test suite
----------------------
2013-12-09 13:01:15 +01:00
2014-01-27 19:11:27 +01:00
$ script/test
2013-12-09 13:01:15 +01:00
2014-02-04 01:02:35 +01:00
Building OS X binaries
---------------------
$ script/build-osx
Note that this only works on Mountain Lion, not Mavericks, due to a [bug in PyInstaller](http://www.pyinstaller.org/ticket/807).
2013-12-09 13:01:15 +01:00
2014-03-04 11:56:41 +01:00
Contributing to Fig
-------------------
If you're looking contribute to [Fig](http://orchardup.github.io/fig/)
but you're new to the project or maybe even to Python, here are the steps
that should get you started.
1. Fork [https://github.com/orchardup/fig](https://github.com/orchardup/fig) to your username. kvz in this example.
1. Clone your forked repository locally `git clone git@github.com:kvz/fig.git`.
1. Enter the local directory `cd fig`.
1. Set up a development environment `python setup.py develop`. That will install the dependencies and set up a symlink from your `fig` executable to the checkout of the repo. So from any of your fig projects, `fig` now refers to your development project. Time to start hacking : )
1. Works for you? Run the test suite via `./scripts/test` to verify it won't break other usecases.
1. All good? Commit and push to GitHub, and submit a pull request.