Table of Contents
Initial setup
Read in the ofn-install wiki about getting an API key if you want to set up a staging or production server.
OpenStreetMaps
Login as superadmin and visit admin/contents/edit.
Find the Map section check the box "Open Street Map enabled"
Google Maps
Disabling "Open Street Map enabled" checkbox will use Google maps by default. For the maps page to work properly, you'll need a Google Maps API key which you can set up as follows:
Dev/local environment
Create a file named .env.development.local in the root of the repo, and add the value like this:
GOOGLE_MAPS_API_KEY="xxxxxxxx"
Staging environment
Same as above, but in staging you'll need to create or edit a file named .env.staging instead. Also, good to keep in mind that this file will be replaced if the server gets provisioned, unless this change has been added to the secrets repo.
Home
Development environment setup
- Pipeline development process
- Bug severity
- Feature template (epic)
- Internationalisation (i18n)
- Dependency updates
Development
- Developer Guidelines
- The process of review, test, merge and deploy
- Making a great commit
- Making a great pull request
- Code Conventions
- Database migrations
- Testing and Rspec Tips
- Testing GitHub Actions Locally with act
- Automated Testing Gotchas
- Rubocop
- Angular and OFN
- Feature toggles
- Stimulus and Turbo
Testing
- Testing process
- OFN Testing Documentation (Handbooks)
- Continuous Integration
- Parallelized test suite with knapsack
- Karma
Releasing
Specific features
Data and APIs
- API documentation
- Authentication
- Integration & API
- Data migration
- Data model diagram (ERD)
- Stripe
- DFC Guide
Instance-specific configuration
External services
Design