raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-01-11 18:26:50 +00:00
Code Issues Packages Projects Releases Wiki Activity
Page: Developer Guidelines
Pages
API Development API documentation Angular and OFN Authentication Automated Testing Gotchas Bug severity Bulk Edit Products admin interface Code, the way we do things (2018) Code Conventions Code review process Configuration Continuous Integration Creating new components DFC Guide Data initialization bootstrapping, seeding, and importing data Data migration Data model diagram (ERD) Database migrations Dependency updates Design styleguide: colors and shadows Design styleguide: fonts and text styles Design styleguide: icons Design styleguide: links and buttons Design styleguide: navigation and menus Design styleguide: size and spacing Design styleguide: tables Design tools Developer Guidelines Developer Manual Development Environment Setup: Debian Development Environment Setup: Fedora Development Environment Setup: OS X (El Capitan) Development Environment Setup: OS X (Mavericks) Development Environment Setup: OS X Development Environment Setup: Ubuntu Development Environment Setup: Windows Development Environment Setup: macOS (Sierra, HighSierra, Mojave and Catalina) Docker: useful tips and commands Emails Enterprises login Feature Testing Handbook Feature template (epic) Feature toggle with Flipper Feature toggles Home How to do Code Reviews Integration & API Internationalisation (i18n) Karma Learning Rails Locale and sample data Making a great commit Making a great pull request Maps Matomo Integration Mexico Overview Parallelized test suite with knapsack Patch Releases Permissions Pipeline development process Product amounts units Release testing automation Releasing Rubocop Sales Tax Set and Deploy on Heroku Setting up Stripe in your local environment Setting up Stripe on an OFN instance Skylight setup Slack notifications from GitHub Spree Commerce customisation Staging with Github Actions Stimulus Stripe testing Stripe Tech Doc: App Routes Tech Doc: Checkout workflow Tech Doc: OFN's Spree fork🍴 Tech Doc: OFN Data Model Single shipment per Order Tech Doc: OFN Data Model Stock locations Tech Doc: OFN Data Model Tech Doc: Orders and Adjustments updates Tech Doc: Scoping Variants and Products to Hubs with VariantOverrides Testing GitHub Actions Locally with act Testing Subscriptions Testing and Rspec Tips Testing process The process of review, test, merge and deploy Troubleshooting your instance Turbo Variant Overrides Who i18n
Clone
2
Developer Guidelines
Luis Ramos edited this page 2020-06-18 10:28:53 +01:00
Table of Contents

This page list things you need to know if you are changing specific parts of the app.

Image paths

Paths for images and icons should be written like this:

  • some form of image helper should always be used, there are various helpers depending on the context and desired output, such as: image_tag, image_path, etc...
  • paths should be relative to the /app/assets/images folder
  • if a path to a static image is not passed to a helper, or is given with a / at the beginning, it will not correctly include the fingerprint, and possibly break
  • for example an image under /app/assets/images/home/banner.jpg should be: image_path("home/banner.jpg"). This will correctly add the fingerprint when generating the image URL.
  • Rails 4 includes some helpers for use within SASS files as well, check out #image-url

Home

Development environment setup

Contributing

Development

Testing

Releasing

Specific features

Data and APIs

Instance-specific configuration

External services

Design