No description, website, or topics provided.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
docs
forestserviceprototype
third-party
.about.yml
.bandit
.gitignore
.python-version
.travis.yml
CONTRIBUTING.md
LICENSE.md
Procfile
README.md
manifest-staging.yml
opencontrol.yaml
pytest.ini
requirements.in
requirements.txt
runtime.txt
system-security-plan.yml

README.md

Build Status Code Climate Test Coverage

Forest Service Prototype

This is a Django application to test out an online permit of the non-commercial group use Forest Service permit.

Guiding documents

This non-commercial group use permit prototype is being developed as part of initial, discovery research for a broader Forest Service ePermitting project. Read more in the discovery plan.

As of November 9, we have completed our first round of discovery research on this prototype. Read the findings and reccomendations from our first round of feedback sessions on this prototype (none of the changes have been implemented yet).

We are now conducting additional research on Christmas tree and outfitter/guide permits, as described in the discovery plan.

Background

In general, this prototype is driven by the goals, users and features set forward at a special uses permitting kick-off workshop. Read more in the special uses workshop summary. In a few weeks, we will kick off a similar discovery effort for Christmas tree permits. Read more in the Christmas tree workshop summary.

For the clearest view of issue priorities and status, check this Waffle board.

Local Installation

This app is designed to run on Python 3.5.2. pyenv is recommended for managing your Python version, along with pyenv-virtualenvwrapper for managing the dependencies installed with pip. With that, you can prepare your development environment by running:

git clone https://github.com/18f/forest-service-prototype.git
cd forest-service-prototype
mkvirtualenv forest-service-prototype
pip install -r requirements.txt
createdb forest-service-prototype
cd forestserviceprototype
./manage.py migrate
./manage.py runserver

The app should now be running at http://localhost:8000.

To generate some data from for development:

./manage.py create_permits

Contributing

Please read through our contributing guidelines. These guidelines are directions for opening issues and submitting pull requests, and they also detail the coding and design standards we follow.

Branching

Release branch: master Development branch: develop

Testing

To run the pytest tests:

cd forestserviceprototype
./manage.py collectstatic
pytest

Dependencies

This project uses pip-tools to manage dependencies. As a result, developers should edit requirements.in and not requirements.txt.

For example:

echo Django >> requirements.in
pip-compile --output-file requirements.txt requirements.in
pip-sync

Factories

There are factories to produce data for existing models. Those factories are used to generate random data for tests or to populate the database during development. While they are random, they are still relatively constrained, and thus shouldn't be considered representative of all of the weird things that humans can try to do. For wackier data, consider using the "Fuzzy" generators included in factoryboy instead of Faker.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication.

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.