Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Adam-W1 committed Aug 23, 2024
1 parent 0739d8e commit ce5609f
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 18 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Contained in [db_tasks.py](./tasks/db_tasks.py)
## Configuration Export Tasks
Contained in [export_tasks.py](./tasks/export_tasks.py)

The configuration output is generated by the [config_generator](./app/export/README.md) module. This module contains functions to generate fund and round configuration, form JSONs, and HTML representations for a given funding round.
The configuration output is generated by the [config_generator](./app/export_config/README.md) module. This module contains functions to generate fund and round configuration, form JSONs, and HTML representations for a given funding round.

## Database
### Schema
Expand Down
25 changes: 9 additions & 16 deletions app/blueprints/self_serve/templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,30 +19,23 @@
<div class="govuk-grid-row">
<div class="govuk-grid-column-two-thirds">
<h1 class="govuk-heading-m">What do you want to do?</h1>
<h2 class="govuk-heading-s">Template Administration</h2>
<h2 class="govuk-heading-s">Template Management</h2>
<ul class="govuk-body">
<li class="govuk-body"><a class="govuk-link" href="{{ url_for('self_serve_bp.question')}}">Add a
Question</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{ url_for('self_serve_bp.question', template='edit') }}">Edit/Delete a
Question</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{ url_for('self_serve_bp.page')}}">Create a
Page</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{ url_for('self_serve_bp.page', template='edit') }}">Edit/Delete a
Page</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{ url_for('self_serve_bp.form')}}">Create an
<li class="govuk-body"><a class="govuk-link" href="/">Edit a
template Question (text only)</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{ url_for('self_serve_bp.form')}}">Create a template
Application Form</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{ url_for('self_serve_bp.form', template='edit') }}">Edit/Delete an
Application Form</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{ url_for('self_serve_bp.section')}}">Create a
Section (Group Forms)</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{ url_for('self_serve_bp.section', template='edit') }}">Edit/Delete a
Section</a></li>
template Section (Form group)</a></li>
<li class="govuk-body"><a class="govuk-link" href="/">Edit a
template Section</a></li>
</ul>
<h2 class="govuk-heading-s">Fund Configuration</h2>
<ul class="govuk-body">
<li class="govuk-body"><a class="govuk-link" href="{{url_for('build_fund_bp.fund')}}">Add a Fund</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{url_for('build_fund_bp.round')}}">Add a Round</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{url_for('build_fund_bp.view_fund')}}">View Fund and Round Config</a></li>
<li class="govuk-body"><a class="govuk-link" href="/">Configure a Round Application</a></li>
<li class="govuk-body"><a class="govuk-link" href="{{url_for('build_fund_bp.view_fund')}}">View Fund Config</a></li>
</ul>
</div>
</div>
Expand Down
14 changes: 13 additions & 1 deletion app/import_config/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,13 @@
TODO
# FAB Config Import

This directory contains the scripts to import the FAB configuration files.

The import configuration file is a form JSON that has been produced by the form designer. The forms are ingested into the FAB database as baseline templates. These templates can then be cloned into applications were users can optionally perform light touch editing of the contained pages and components.

To import a form JSON, each file should be places in the following directory:

app/import_config/files_to_import/ ** ({formname}.json)

The import can be triggered manually by running the following command:

python app/import_config/import_config.py

0 comments on commit ce5609f

Please sign in to comment.