Skip to content

Latest commit

 

History

History
114 lines (67 loc) · 4.3 KB

install.rst

File metadata and controls

114 lines (67 loc) · 4.3 KB
Raw

Here are some guidelines for how to structure Django apps to fit the GeoCam conventions.

We chose to base our design off the django-app-skeleton app generator.

App directory/repo layout

  • geocamAwesome/
    • README.rst -- what is this app? what does it do? in wiki-like reStructuredText format
    • setup.py -- setuptools, probably with some custom commands to do cool stuff.
    • geocamAwesome/
      • Django code (models, views, etc)
      • templates, templatetags
      • media/geocamAwesome
        • images, css, javascript [should we split this up into further subdirs?]
      • tests
    • bin/ -- other things which don't belong with the web code, but need to be run or interact with the app. Also, misc utilities.
    • doc_src/ -- rst files for documentation about the app (For automatic, sexy, html documentation generation. Yes. Sexy.)
    • LICENSE-2.0 - the Apache 2.0 license
    • MANIFEST.in -- setuptools file. ignore.

Skeleton generation

Now that you know what one looks like, know that you don't have to make it yourself! An app generator has been created to make the magic happen. Let's take the fictional app of geocamAwesome. You can create this bag of awesome-sauce in 5 easy steps:

  1. Create the geocamAwesomeWeb repository. On GitHub, you do this by clicking on Dashboard, then New Repository.

  2. Clone your master repo locally:

    git clone git@github.com:$GITHUBUSER/geocamAwesomeWeb.git

  3. Clone the GeoCam Django app generator from GitHub. (It doesn't matter where you put it, you will only need the generator to create your app, then you can get rid of it.):

    git clone https://github.com/geocam/geocamDjangoAppSkeleton.git

  4. cd to the parent directory of your geocamAwesomeWeb checkout and fill in your blank repo by running:

    geocamDjangoAppSkeleton/create_app.py
At the prompts, you want the app name to be geocamAwesomeWeb and the package name to be geocamAwesome. The author should be GeoCam Project.
  1. Profit!

Don't forget to commit the newly created little files of joy to the geocamAwesome git repo!

Sites

Overall, we are dealing with a server that will be comprised of a bunch of Django applications. These apps need to be put into one cohesive Django site that makes sense for the responders we are supporting. Structuring the Django apps in a consistent manner makes it easier to create the site in a standard way, but we still need to define the glue code.

Site Directory Layout

  • geocamSite/
    • siteSettings.py -- default site settings, may override app-default settings
    • settings.py -- this checkout's local, overridden settings. (db setup, etc)
    • geocamApp1 --(symlink)--> submodules/geocamApp1/geocamApp1
    • geocamApp2 --(symlink)--> submodules/geocamApp2/geocamApp2
    • submodules/
      • geocamApp1/ -- submodule repo
      • geocamApp2 -- submodule repo
    • README.rst -- what is this repo? in wiki-like reStructuredText format
    • setup.py -- setuptools Python file (will probably setup the symlinks, etc)

Site skeleton generation

There is to skeleton generation for sites yet, sorry!

__BEGIN_LICENSE__
Copyright (c) 2015, United States Government, as represented by the
Administrator of the National Aeronautics and Space Administration.
All rights reserved.

The xGDS platform is licensed under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with the License.
You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.
__END_LICENSE__