Integration & API

wvengen edited this page 2015-12-14 20:24:36 +01:00

Table of Contents

• Profiles, Social Networking & Relationships
• Business Management
• Food Enterprise Systems
• Food Cooperative Systems
• Transport and Distribution

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This page outlines some of the potential interfaces with other software packages and systems that could build functionality of what we're doing.

We would like to be able to connect with other services for many of the following functions. As a general rule, we will prioritise links with other open source projects. Where these don't exist (or don't yet provide sufficient functionality), we will build relationships with other useful and well-used services.

An important means of interacting with other services would be our API.

Profiles, Social Networking & Relationships

• Login and 'info sharing' services: Facebook, Twitter, Google, Persona?, OpenID
• Food system mapping and directory sites: Sustaination; Local Harvest; Dibble etc NB. As far as we know, there is not yet a FOSS option for food business mapping – let us know if there is . .

Business Management

• OpenERP*
• Accounting Packages: Quickbooks; Xero; Saasu etc

Food Enterprise Systems

• Bello Box*, Bucky Box, Ooooby
• Food Connect, CERES Fair Food
• Food Hub Software: StroudCo; OpenFoodSource; Food Hub Pro etc?

Food Cooperative Systems

These systems focus on supporting a food cooperative. This is similar to a buying group in Open Food Network. These systems could integrate by importing supplier and product information from OFN, as well as by being able to place orders with suppliers through OFN.

• Foodsoft, Cagette, Aixada and more

Transport and Distribution

• MeeMeep
• BringBee
• New OS Distribution system?

Home

Development environment setup

• Learning Rails
• Getting started
• Ubuntu
• Debian
• Fedora
• OS X
• Windows
• Docker

Contributing

• 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

• Releasing
• Patch Releases

Specific features

• Sales Tax
• Product amounts units
• Stripe
• Maps

Data and APIs

• API documentation
• Authentication
• Integration & API
• Data migration
• Data model diagram (ERD)
• Stripe
• DFC Guide

Instance-specific configuration

• Locale and sample data
• Troubleshooting your instance

External services

• Setting up Stripe on an OFN instance
• Skylight setup

Design

• Design styleguide: colors and shadows
• Design styleguide: fonts and text styles
• Design styleguide: size and spacing
• Design styleguide: icons
• Design styleguide: links and buttons
• Design styleguide: navigation and menus
• Design styleguide: tables
• Design tools