From d9ed34f5f2c6c608f1da654e3165354e0a5c010c Mon Sep 17 00:00:00 2001 From: Rodolfo Carvalho Date: Fri, 29 May 2015 17:19:22 +0200 Subject: [PATCH] Update README --- README.md | 43 ++++++++++++++++++++++++++++++------------- 1 file changed, 30 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 5f82a19..9aa7acb 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,30 @@ -# Openshift Django quickstart +# Openshift quickstart: Django + +This is a [Django](http://www.djangoproject.com) project that you can use as the starting point to develop your own and deploy it on an [OpenShift](https://github.com/openshift/origin) cluster. -This project is meant to be forked and used to quickly deploy a Django web application to an [OpenShift](https://github.com/openshift/origin) cluster. It assumes you have access to an existing OpenShift installation. -You can use this as a starting point to build your own application. +## What has been done for you -## Getting started +This is a minimal Django 1.8 project. It was created with these steps: + +1. Create a virtualenv +2. Manually install Django and other dependencies +3. `pip freeze > requirements.txt` +4. `django-admin startproject project .` +3. Manually update `project/settings.py` to configure `SECRET_KEY`, `DATABASE` and `STATIC_ROOT` entries. +4. `./manage.py startapp openshift`, to create the welcome page's app + + +## Local development + +To run this project in your development machine, follow these steps: 1. (optional) Create and activate a [virtualenv](https://virtualenv.pypa.io/) (you may want to use [virtualenvwrapper](http://virtualenvwrapper.readthedocs.org/)). 2. Fork this repo and clone your fork: - `git clone https://github.com/rhcarvalho/openshift-django-quickstart.git` + `git clone https://github.com/openshift/django-ex.git` 3. Install dependencies: @@ -27,16 +40,15 @@ You can use this as a starting point to build your own application. 5. Open your browser and go to http://127.0.0.1:8000, you will be greeted with a welcome page. -## What has been done for you -This is a minimal Django 1.8 project. It was created with these steps: +## Special files in this repository -1. Create a virtualenv -2. Manually install requirements -3. `pip freeze > requirements.txt` -4. `django-admin startproject PROJECT_NAME .` -3. Manually update `project/settings.py` to configure `SECRET_KEY`, `DATABASE` and `STATIC_ROOT` entries. -4. `./manage.py startapp openshift`, to create the welcome page's app +[TODO] + +``` +.sti/ - scripts used by source-to-image +openshift/ - application templates +``` ## Deploying to OpenShift @@ -48,3 +60,8 @@ Now you can browse to your OpenShift web console and create a new app from the ' After adjusting your preferences (or accepting the defaults), your application will be built and deployed. You will probably want to set the `GIT_REPOSITORY` parameter to point to your fork. + + +## Data persistence + +[TODO]