QingdaoU/Spirit
1
0
Fork 0
mirror of https://github.com/QingdaoU/Spirit.git synced 2024-12-29 16:02:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

readme installation

Browse Source
This commit is contained in:
nitely 2015-10-20 22:23:59 -03:00
parent 318b84c8e5
commit 18f21fb574
2 changed files with 16 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -17,34 +17,7 @@ To see it in action, please visit [The Spirit Project](http://spirit-project.com
## Installing (Advanced)
Check out the [example](https://github.com/nitely/Spirit/tree/master/example) provided.
In short:
Add `url(r'^', include('spirit.urls')),` to your *urls.py*
Add `from spirit.settings import *` to the top of your *settings.py* file,
otherwise you will have to setup all django's related constants (Installed_apps, Middlewares, Login_url, etc)
Run:
pip install django-spirit
python manage.py spiritinstall
> You will need to setup a search engine,
> Spirit is configured to work with [Woosh](https://bitbucket.org/mchaput/whoosh/wiki/Home) by default.
>
> An email server is required, you can host your own (ie: [exim](http://www.exim.org/)),
> or hire an external service provider (ie: [Mandrill](http://mandrill.com/)).
Start a development server:
python manage.py runserver
Visit (http://127.0.0.1:8000/)
> On production, you would rather run Spirit on a real web server. ie: gunicorn + Nginx.
> Running Spirit on a [virtualenv](http://www.virtualenv.org) is adviced.
Check out the [example project](https://github.com/nitely/Spirit/tree/master/example).
## Upgrading

19
example/README.md
View File

@ -13,12 +13,23 @@ Spirit example application in this directory:
$ python manage.py spiritinstall
$ python manage.py runserver
You should then be able to open your browser on http://127.0.0.1:8000 and
see the Spirit homepage.
Visit http://127.0.0.1:8000/
> This will run using the *developer* settings,
> which are not suitable for production environments.
> In production, you should create a `prod_local.py`,
> On production, you should create a `prod_local.py`,
> import the production settings `from .prod import *`
> and overwrite settings such as `SECRET_KEY`, `DATABASES` and `ALLOWED_HOSTS`.
> and overwrite settings such as `SECRET_KEY`, `DATABASES` and `ALLOWED_HOSTS`.
>
> You should run Spirit on a real web server. ie: gunicorn + Nginx.
> An email server is required, you can host your own (ie: [exim](http://www.exim.org/)),
> or hire an external service provider (ie: [Mandrill](http://mandrill.com/)).
> You will need to setup a search engine,
> Spirit is configured to work with [Woosh](https://bitbucket.org/mchaput/whoosh/wiki/Home) by default.