isabella232 / cfgov-satellite

cookiecutter template for a cf.gov satellite app

CFPB cf.gov Satellite Template Instructions

1. Install Cookiecutter

   pip install --user cookiecutter
   

   Or with pipsi:

   pipsi install cookiecutter
   

2. Use Cookiecutter and this repository to make a new satellite app

   cookiecutter https://github.com/cfpb/cfgov-satellite

   Cookiecutter will prompt you for the package name:

   package_name [satellite app package name]: my_satellite_app
   

   package_name can be letters or underscores and will be the name given to the Python package, the template subdirectory, and compiled CSS and JavaScript files. In this example my_satellite_app would be the app name that gets included in INSTALLED_APPS.

3. Follow the cfgov-refresh instructions for using this app

4. Update the README, replacing the contents below as prescribed.

5. Add any libraries, assets, or hard dependencies whose source code will be included in the project's repository to the Exceptions section in the TERMS.

• If no exceptions are needed, remove that section from TERMS.

6. If working with an existing code base, answer the questions on the open source checklist

7. Delete these instructions and everything up to the Project Title from the README.

8. Write some great software and tell people about it.

Keep the README fresh! It's the first thing people see and will make the initial impression.