imacat/mia-accounting-django
1
0
Fork 0
Code Issues Pull Requests Projects Releases 4 Wiki Activity

Revised the README.

Browse Source
This commit is contained in:
依瑪貓 2020-09-07 07:18:12 +08:00
parent a7d6943417
commit 774fb28981
1 changed files with 49 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
README.md
View File

@ -1,6 +1,6 @@
# mia-accounting # mia-accounting
The Mia! Accounting Application Built on Python Django The Mia! Accounting Django Application
``` ```
Copyright (c) 2020 imacat. Copyright (c) 2020 imacat.
@ -21,64 +21,89 @@ The Mia! Accounting Application Built on Python Django
## Live Demonstration ## Live Demonstration
https://accounting.imacat.idv.tw/accounting https://accounting.imacat.idv.tw/accounting
* Username: admin * Username: `admin`
* Password: 12345 * Password: `12345`
## Installation ## Installation
### Requirements ### Requirements
Installs the following requirements with pip: `mia-accounting` requires Python 3.6 or above to work.
Install the required packages with `pip`.
```
pip install django django-dirtyfields titlecase django-decorator-include
```
* Python 3.6 or above
* Django 3.0 or above
* django-dirtyfields
* django-decorator-include
* titlecase
### Download ### Download
Clones the project from GitHub The Mia! Accounting project is hosted on GitHub.
https://github.com/imacat/mia-accounting
You can download or clone
the project from from GitHub
``` ```
git clone git@github.com:imacat/mia-accounting.git git clone git@github.com:imacat/mia-accounting.git
``` ```
Moves the accounting and mia_core directories into your Django project root Move the `accounting` and `mia_core` directories into your Django project root
directory. directory.
### Configure Your settings.py ### `settings.py`
Adds these two applications into your INSTALL_APPS. Add these two applications in the `INSTALL_APPS` section of your `settings.py`.
``` ```
'mia_core.apps.MiaCoreConfig' INSTALLED_APPS = [
'accounting.apps.AccountingConfig' 'mia_core.apps.MiaCoreConfig',
'accounting.apps.AccountingConfig',
...
]
``` ```
Adds the locale middleware if it is not added yet. Make sure the locale middleware is in the `MIDDLEWARE` section of your
`settings.py`, and add it if it is not added yet.
``` ```
'django.middleware.locale.LocaleMiddleware' MIDDLEWARE = [
...
'django.middleware.locale.LocaleMiddleware',
...
]
``` ```
### Configure Your urls.py: ### `urls.py`
Adds this line into your urls.py: Add the `accounting` application in the `urlpatterns` of your `urls.py`.
``` ```
urlpatterns = [
...
path('accounting/', decorator_include(login_required, 'accounting.urls')), path('accounting/', decorator_include(login_required, 'accounting.urls')),
...
]
``` ```
Ensures these two lines are also in your urls.py, if they are not yet: Make sure `i18n` and `jsi18n` are also in the `urlpatterns` of your `urls.py`,
and add them if they are not added yet.
``` ```
urlpatterns = [
...
path('i18n/', include("django.conf.urls.i18n")), path('i18n/', include("django.conf.urls.i18n")),
path('jsi18n/', JavaScriptCatalog.as_view(), name='javascript-catalog'), path('jsi18n/', JavaScriptCatalog.as_view(), name='javascript-catalog'),
...
]
``` ```
### Restarts Your Web Project ### Restart Your Web Project
## Bugs and Supports ## Bugs and Supports
Address all bugs and support requests to imacat@mail.imacat.idv.tw. Address all bugs and support requests to imacat@mail.imacat.idv.tw.
2020/9/7