The Project Application and Funding Service (PAFS) is used by regional management authorities to apply for funding for flood and coastal risk management projects.
The application sends emails using the Send-grid e-mail service.
For a full breakdown of the PAFS documentation, technical and non technical please click the link
The following system dependencies are required, regardless of how you install the development environment.
Clone the repository, copying the project into a working directory:
git clone https://github.com/EnvironmentAgency/pafs-user.git
cd pafs-user
We use "git flow" to manage development and features branches. To initialise git flow for the project, you need to run:
git checkout -t origin/main
git flow init # choose the defaults
git checkout develop
See the Wiki page on Git Flow, for more information about our branching strategy.
- Ruby 3.2.2 (e.g. via RVM or Rbenv)
- Postgresql
- Phantomjs (test specs)
Run the following to download the app dependencies (rubygems)
cd <pafs-project-directory>
gem install bundler
bundle install
The project uses the dotenv gem which allows enviroment variables to be loaded from a .env configuration file in the project root.
Duplicate ./dotenv.example and rename the copy as ./.env. Open it and update SECRET_KEY_BASE and settings for database, email etc. - Secret Key base can be anything
There are several databases per environment, therefore, ensure you run the following:
bundle exec rake db:create:all
bundle exec rake db:schema:load
bundle config local.pafs_core /path/to/local/pafs_core
bundle
To start the service locally simply run:
bundle exec rails server
You can then access the web site at http://localhost:3000
You can use mailcatcher to trap and view outgoing email.
Make sure you have the following in your .env or .env.development file:
SECRET_KEY_BASE=''
DATABASE_USERNAME=''
DATABASE_PASSWORD=''
DEVISE_USER_SEPARATE_DB=''
DEVISE_MAILER_SENDER=''
AIRBRAKE_HOST=''
AIRBRAKE_PROJECT_KEY=''
GOOGLE_ANALYTICS_ID=''
EMAIL_USERNAME=''
EMAIL_PASSWORD=''
EMAIL_APP_DOMAIN=''
EMAIL_HOST=''
EMAIL_PORT=''
ENABLE_USER_AREAS=''
Start mailcatcher with $ mailcatcher and navigate to
http://127.0.0.1:1080 in your browser.
Note that mail_safe maybe also be running in which case any development email will seem to be sent to your global git config email address.
There are times when we require our environments to be cleared of projects and put into a known state. This is typical when we require that the service has no proposals, or their associated data.
The following command (bundle exec projects:delete_all) will remove all proposals from the service, leaving the existing users and their associated area's intact.
We use tools like rubocop, brakeman, and i18n-tasks to help maintain quality, reusable code. Rather than running them manually we automate it via GitHub actions.
We use RSpec for unit testing, and intend to use Cucumber for our acceptance testing.
Before executing the tests for the first time, you will need to seed the database:
bundle exec rake db:seed RAILS_ENV=test
To execute the unit tests simply enter:
rspec
As this point we have no acceptance tests but when we do they can be executed using:
cucumber
To launch a rails console on a deployed server, the environment variables might need to be loaded from a different directory
For example:
. ../../.exportedenv && RAILS_ENV=production bundle exec rails console
Currently (15 Jun 2021), no logs are written to the production.log. This should be fixed.
When the file upload fails, the user sees a 'cookies' error. This might come from an InvalidAuthenticityToken, which might also come from a Clam AV error.
It's worth checking that the Clam AV service is running: https://github.com/franckverrot/clamav-client#ping--boolean
A maintenance routine needs to be run each April at the start of the new financial year to remove all previous year’s data for return to ‘draft’ & ‘archived’ projects. PMs are expected to re-profile their ‘funding’ & ‘risks and properties benefitting’ requirements to current and future years. It will remove all years before current financial year.
The rake task to run is pafs:remove_previous_years[max_records] where max_records is the number of records to process e.g. pafs:remove_previous_years[10000].
If you have an idea you'd like to contribute please log an issue.
All contributions should be submitted via a pull request.
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
http://www.nationalarchives.gov.uk/doc/open-government-licence/version/3
The following attribution statement MUST be cited in your products and applications when using this information.
Contains public sector information licensed under the Open Government license v3
The Open Government Licence (OGL) was developed by the Controller of Her Majesty's Stationery Office (HMSO) to enable information providers in the public sector to license the use and re-use of their information under a common open licence.
It is designed to encourage use and re-use of information freely and flexibly, with only a few conditions.