File tree Expand file tree Collapse file tree 15 files changed +48
-13
lines changed Expand file tree Collapse file tree 15 files changed +48
-13
lines changed Original file line number Diff line number Diff line change @@ -11,7 +11,7 @@ Django Ledger was created by [Miguel Sanda](https://github.com/elarroba).
11
11
* Miguel Sanda [ @elarroba ] ( https://github.com/elarroba )
12
12
* Michael Noel [ @mnooel ] ( https://github.com/mnooel )
13
13
14
- ### Accountants & Bookkeepers
14
+ ### Accountants, CPAs & Bookkeepers
15
15
* Miguel Sanda [ @elarroba ] ( https://github.com/elarroba )
16
16
* Albert Salazar [ @Beachwood619 ] ( https://github.com/Beachwood619 )
17
- * Michael Noel [ @mnooel ] ( https://github.com/mnooel )
17
+ * Michael Noel, CPA [ @mnooel ] ( https://github.com/mnooel )
Original file line number Diff line number Diff line change @@ -97,8 +97,44 @@ urlpatterns = [
97
97
]
98
98
```
99
99
100
- # Screenshots
100
+ # How To Set Up Django Ledger for Development
101
+ Django Ledger comes with a basic development environments already configured under __ dev_env/__ folder not to be used
102
+ for production environments. If you want to contribute to the project perform the following steps:
103
+
104
+ 1 . Navigate to your projects directory.
105
+ 2 . Clone the repo from github and CD into project.
106
+ ``` shell
107
+ git clone https://github.com/arrobalytics/django-ledger.git
108
+ cd django-ledger
109
+ ```
110
+ 3 . Install PipEnv, if not already installed:
111
+ ``` shell
112
+ pip install -U pipenv
113
+ ```
114
+ 4 . Create virtual environment.
115
+ ``` shell
116
+ pipenv install
117
+ ```
118
+ If using a specific version of Python you may specify the path.
119
+ ``` shell
120
+ pipenv install --python PATH_TO_INTERPRETER
121
+ ```
122
+ 5 . Activate environment.
123
+ ``` shell
124
+ pipenv shell
125
+ ```
126
+ 7 . Run development server.
127
+ ``` shell
128
+ python manage.py runserver
129
+ ```
101
130
131
+ # Run Test Suite
132
+ After setting up your development environment you may run tests.
133
+ ``` shell
134
+ python manage.py test django_ledger
135
+ ```
136
+
137
+ # Screenshots
102
138
![ django ledger entity dashboard] ( https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_entity_dashboard.png )
103
139
![ django ledger balance sheet] ( https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_income_statement.png )
104
140
![ django ledger income statement] ( https://us-east-1.linodeobjects.com/django-ledger/public/img/django_ledger_balance_sheet.png )
File renamed without changes.
Original file line number Diff line number Diff line change 2
2
3
3
from django .core .asgi import get_asgi_application
4
4
5
- os .environ .setdefault ('DJANGO_SETTINGS_MODULE' , 'tests .settings' )
5
+ os .environ .setdefault ('DJANGO_SETTINGS_MODULE' , 'dev_env .settings' )
6
6
7
7
application = get_asgi_application ()
Original file line number Diff line number Diff line change 14
14
'django.contrib.messages' ,
15
15
'django.contrib.staticfiles' ,
16
16
17
- 'tests' ,
18
17
'django_ledger'
18
+
19
19
]
20
20
21
21
MIDDLEWARE = [
28
28
'django.middleware.clickjacking.XFrameOptionsMiddleware' ,
29
29
]
30
30
31
- ROOT_URLCONF = 'tests .urls'
31
+ ROOT_URLCONF = 'dev_env .urls'
32
32
33
33
TEMPLATES = [
34
34
{
47
47
},
48
48
]
49
49
50
- WSGI_APPLICATION = 'tests .wsgi.application'
50
+ WSGI_APPLICATION = 'dev_env .wsgi.application'
51
51
52
52
# Database
53
53
# https://docs.djangoproject.com/en/2.2/ref/settings/#databases
File renamed without changes.
Original file line number Diff line number Diff line change 2
2
3
3
from django .core .wsgi import get_wsgi_application
4
4
5
- os .environ .setdefault ('DJANGO_SETTINGS_MODULE' , 'tests .settings' )
5
+ os .environ .setdefault ('DJANGO_SETTINGS_MODULE' , 'dev_env .settings' )
6
6
7
7
application = get_wsgi_application ()
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change 1
1
from django .urls import reverse
2
2
3
- from tests .base import DjangoLedgerBaseTest
4
- from tests .settings import LOGIN_URL
3
+ from django_ledger . tests .base import DjangoLedgerBaseTest
4
+ from dev_env .settings import LOGIN_URL
5
5
6
6
7
7
class AuthTest (DjangoLedgerBaseTest ):
@@ -73,4 +73,3 @@ def test_user_can_logout(self):
73
73
74
74
response = self .client .get (logout_url )
75
75
self .assertRedirects (response , expected_url = login_url )
76
-
Original file line number Diff line number Diff line change @@ -211,7 +211,7 @@ def test_entity_views(self):
211
211
text = reverse ('django_ledger:entity-delete' ,
212
212
kwargs = {
213
213
'entity_slug' : entity_model .slug
214
- })) # ENTITY-LIST VIEW...
214
+ })) # ENTITY-LIST VIEW...
215
215
216
216
# # HOME VIEW
217
217
# with self.assertNumQueries(3):
Original file line number Diff line number Diff line change 6
6
7
7
def main ():
8
8
"""Run administrative tasks."""
9
- os .environ .setdefault ('DJANGO_SETTINGS_MODULE' , 'tests .settings' )
9
+ os .environ .setdefault ('DJANGO_SETTINGS_MODULE' , 'dev_env .settings' )
10
10
try :
11
11
from django .core .management import execute_from_command_line
12
12
except ImportError as exc :
You can’t perform that action at this time.
0 commit comments