QingdaoU/Spirit
1
0
Fork 0
mirror of https://github.com/QingdaoU/Spirit.git synced 2024-12-28 23:41:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
master
Spirit/README.md

48 lines
1.3 KiB
Markdown
Raw Permalink Normal View History

readme
2015-04-01 19:44:58 +00:00
# Spirit
[![Build Status](https://img.shields.io/travis/nitely/Spirit.svg?style=flat-square)](https://travis-ci.org/nitely/Spirit)
[![Coverage Status](https://img.shields.io/coveralls/nitely/Spirit.svg?style=flat-square)](https://coveralls.io/r/nitely/Spirit)
[![pypi](https://img.shields.io/pypi/v/django-spirit.svg?style=flat-square)](https://pypi.python.org/pypi/django-spirit)
readme licence badge
2015-04-01 19:48:51 +00:00
[![licence](https://img.shields.io/pypi/l/django-spirit.svg?style=flat-square)](https://raw.githubusercontent.com/nitely/Spirit/master/LICENSE)
Initial commit
2014-05-09 21:34:48 +00:00
Spirit is a Python based forum built using the Django framework.
To see it in action, please visit [The Spirit Project](http://spirit-project.com/).
readme Requirements -> Compatibility
2015-09-23 22:45:32 +00:00
## Compatibility
Initial commit
2014-05-09 21:34:48 +00:00
Feature/django1 11 (#200) * update requirements * update compatibility * update travis * update history
2017-09-25 06:28:35 +00:00
* Python 2.7, 3.4, 3.5 and 3.6 (recommended)
* Django 1.8 LTS, 1.9, 1.10 and 1.11 LTS (recommended)
readme Requirements -> Compatibility
2015-09-23 22:45:32 +00:00
* PostgreSQL (recommended), MySQL, Oracle Database and SQLite
Initial commit
2014-05-09 21:34:48 +00:00
Feature/install (#193) * add yarn * spirit startproject command * readme usage * remove example from travis * readme run tests * exit instead of raise * remove yarn.lock * core.conf settings * django.conf.settings -> core.conf.settings everywhere * editorconfig makefiles * docs * core.conf.defaults docs * installation docs * upgrade docs * update history * spirit.settings deprecation warning * update readme
2017-09-24 15:38:54 +00:00
## Usage
Initial commit
2014-05-09 21:34:48 +00:00
*new in ...* usage note
2017-09-25 09:01:28 +00:00
> New in Spirit 0.5
```
Feature/install (#193) * add yarn * spirit startproject command * readme usage * remove example from travis * readme run tests * exit instead of raise * remove yarn.lock * core.conf settings * django.conf.settings -> core.conf.settings everywhere * editorconfig makefiles * docs * core.conf.defaults docs * installation docs * upgrade docs * update history * spirit.settings deprecation warning * update readme
2017-09-24 15:38:54 +00:00
pip install django-spirit
spirit startproject mysite
cd mysite
python manage.py spiritinstall
python manage.py createsuperuser
python manage.py runserver
```
Initial commit
2014-05-09 21:34:48 +00:00
Feature/install (#193) * add yarn * spirit startproject command * readme usage * remove example from travis * readme run tests * exit instead of raise * remove yarn.lock * core.conf settings * django.conf.settings -> core.conf.settings everywhere * editorconfig makefiles * docs * core.conf.defaults docs * installation docs * upgrade docs * update history * spirit.settings deprecation warning * update readme
2017-09-24 15:38:54 +00:00
Visit [http://127.0.0.1:8000](http://127.0.0.1:8000)
Initial commit
2014-05-09 21:34:48 +00:00
Feature/install (#193) * add yarn * spirit startproject command * readme usage * remove example from travis * readme run tests * exit instead of raise * remove yarn.lock * core.conf settings * django.conf.settings -> core.conf.settings everywhere * editorconfig makefiles * docs * core.conf.defaults docs * installation docs * upgrade docs * update history * spirit.settings deprecation warning * update readme
2017-09-24 15:38:54 +00:00
For detailed installation and setup docs, see [spirit.readthedocs.io](http://spirit.readthedocs.io/en/latest/)
Initial commit
2014-05-09 21:34:48 +00:00
Feature/install (#193) * add yarn * spirit startproject command * readme usage * remove example from travis * readme run tests * exit instead of raise * remove yarn.lock * core.conf settings * django.conf.settings -> core.conf.settings everywhere * editorconfig makefiles * docs * core.conf.defaults docs * installation docs * upgrade docs * update history * spirit.settings deprecation warning * update readme
2017-09-24 15:38:54 +00:00
## Documentation
Docs can be found at [spirit.readthedocs.io](http://spirit.readthedocs.io/en/latest/)
Separate example and tests Each folder has is own settings and urls and can be tested with `runtests.py` 1. `./runtests` run tests with `tests/settings.py` file 2. `./runtests example` run tests with `example/settings.py` file `runtests.py` write to stdout the settings file used.
2014-11-25 13:13:17 +00:00
Feature/install (#193) * add yarn * spirit startproject command * readme usage * remove example from travis * readme run tests * exit instead of raise * remove yarn.lock * core.conf settings * django.conf.settings -> core.conf.settings everywhere * editorconfig makefiles * docs * core.conf.defaults docs * installation docs * upgrade docs * update history * spirit.settings deprecation warning * update readme
2017-09-24 15:38:54 +00:00
## Testing
Separate example and tests Each folder has is own settings and urls and can be tested with `runtests.py` 1. `./runtests` run tests with `tests/settings.py` file 2. `./runtests example` run tests with `example/settings.py` file `runtests.py` write to stdout the settings file used.
2014-11-25 13:13:17 +00:00
*new in ...* usage note
2017-09-25 09:01:28 +00:00
```
python runtests.py
Feature/install (#193) * add yarn * spirit startproject command * readme usage * remove example from travis * readme run tests * exit instead of raise * remove yarn.lock * core.conf settings * django.conf.settings -> core.conf.settings everywhere * editorconfig makefiles * docs * core.conf.defaults docs * installation docs * upgrade docs * update history * spirit.settings deprecation warning * update readme
2017-09-24 15:38:54 +00:00
```
Separate example and tests Each folder has is own settings and urls and can be tested with `runtests.py` 1. `./runtests` run tests with `tests/settings.py` file 2. `./runtests example` run tests with `example/settings.py` file `runtests.py` write to stdout the settings file used.
2014-11-25 13:13:17 +00:00
readme
2015-04-01 19:44:58 +00:00
## License
Initial commit
2014-05-09 21:34:48 +00:00
readme
2015-04-01 19:44:58 +00:00
MIT
Reference in New Issue Copy Permalink