mirror of
https://github.com/QingdaoU/Spirit.git
synced 2025-01-16 09:15:59 +00:00
48 lines
1.3 KiB
Markdown
48 lines
1.3 KiB
Markdown
# Spirit
|
|
|
|
[](https://travis-ci.org/nitely/Spirit)
|
|
[](https://coveralls.io/r/nitely/Spirit)
|
|
[](https://pypi.python.org/pypi/django-spirit)
|
|
[](https://raw.githubusercontent.com/nitely/Spirit/master/LICENSE)
|
|
|
|
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/).
|
|
|
|
## Compatibility
|
|
|
|
* Python 2.7, 3.4, 3.5 and 3.6 (recommended)
|
|
* Django 1.8 LTS, 1.9, 1.10 and 1.11 LTS (recommended)
|
|
* PostgreSQL (recommended), MySQL, Oracle Database and SQLite
|
|
|
|
## Usage
|
|
|
|
> New in Spirit 0.5
|
|
|
|
```
|
|
pip install django-spirit
|
|
spirit startproject mysite
|
|
cd mysite
|
|
python manage.py spiritinstall
|
|
python manage.py createsuperuser
|
|
python manage.py runserver
|
|
```
|
|
|
|
Visit [http://127.0.0.1:8000](http://127.0.0.1:8000)
|
|
|
|
For detailed installation and setup docs, see [spirit.readthedocs.io](http://spirit.readthedocs.io/en/latest/)
|
|
|
|
## Documentation
|
|
|
|
Docs can be found at [spirit.readthedocs.io](http://spirit.readthedocs.io/en/latest/)
|
|
|
|
## Testing
|
|
|
|
```
|
|
python runtests.py
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|