Skip to content
This repository
Browse code

orgniazing the project

  • Loading branch information...
commit a48338029d35e2b682982c5f8c77aa14ead26b33 1 parent 9b594c9
ahmad authored
20 geogeld/Developers_Guide.txt
... ... @@ -0,0 +1,20 @@
  1 +__author__ = "Ahmad Moalla"
  2 +__email__ = "ahm@berlin.com"
  3 +'''
  4 +1. Use only relative paths if possible (configuration only relative paths).
  5 +2. Use the {% url %} tag
  6 + Instead of hardcoding individual links, try using the backwards compatible {% url %} tag to achieve the same result. This will give you the absolute URL, so that if, heaven forbid, your Django project moves the links will still remain in tact.
  7 +3. Document your code explaining by comments what you are doing, imagine your grandma is reading the code, make her proud :)
  8 +4. Use the #TODO tag to mark what is next.
  9 +5. Think about django admin when writing models.
  10 +6. Put all static files in Static folder (images, js or CSS) define new directory if needed for new types.
  11 +7. Put all templates in templates directory. Create new directories for each app.
  12 +8. Avoid using third parties app and scripts if possible. Django has an amazing power, let's use it to the max.
  13 +9. Write test of your defined models and views.
  14 +10. For each new python file write your name and email at the top of the page using the __aithor__ and __email__ tags.
  15 +11. For each new view and email , write your name and email into a comment.
  16 +12. Add and correct what you think is wrong in this document or anywhere in the project.
  17 +13. Write unit tests if possible.
  18 +14. Have a look at this Django cheat_sheet : http://www.mercurytide.co.uk/media/whitepapers/django-cheat-sheet/django10-cheat-sheet.pdf
  19 +15. Stick to the Issue Tracking System we are suing. Currently we use the github issues feature, but this will change soon. Make comments and enhance the issues there : https://github.com/ahmadmoalla/geogeld/issues?milestone=1&state=open
  20 +'''
8 geogeld/settings.py
@@ -67,9 +67,7 @@
67 67
68 68 # Additional locations of static files
69 69 STATICFILES_DIRS = (
70   - # Put strings here, like "/home/html/static" or "C:/www/django/static".
71   - # Always use forward slashes, even on Windows.
72   - # Don't forget to use absolute paths, not relative paths.
  70 + 'static',
73 71 )
74 72
75 73 # List of finder classes that know how to find static files in
@@ -106,9 +104,7 @@
106 104 WSGI_APPLICATION = 'geogeld.wsgi.application'
107 105
108 106 TEMPLATE_DIRS = (
109   - # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
110   - # Always use forward slashes, even on Windows.
111   - # Don't forget to use absolute paths, not relative paths.
  107 + 'templates'
112 108 )
113 109
114 110 INSTALLED_APPS = (
3  requirements.txt
... ... @@ -0,0 +1,3 @@
  1 +#Add all what you install into your Virtualenv to this file
  2 +#pip instal reuirements.txt to install all the required apps
  3 +Django==1.4

0 comments on commit a483380

Please sign in to comment.
Something went wrong with that request. Please try again.