Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 3.5 KB

README.md

File metadata and controls

75 lines (51 loc) · 3.5 KB

Foodie

License Github Releases

Foodie is a free and open-source client for Open Food Facts. Foodie works on each desktop platform - it is based on Electron, licensed under the MIT license.


Contributing

Bug reporting

Github Open Issues Github Closed Issues Github Pull Requests

We want contributing to Foodie to be fun, enjoyable, and educational for everyone. Changes and improvements are more than welcome! Feel free to fork and open a pull request. If you have found any issues, please report them here - they are being tracked on GitHub Issues.

License

Foodie was created and developed by Bartosz Łaniewski. The full list of contributors can be found here. Foodie's code is MIT licensed.

Development

We have prepared multiple commands to help you develop Foodie on your own. You will need a local copy of Node.js installed on your machine. First, you need to clone or download our repository:

$ git clone --depth=1 https://github.com/Bartozzz/foodie-app.git foodie

…and install dependencies with npm:

$ npm install

Usage

$ npm run <command>

List of commands

Command Description
dev Runs Foodie in development mode
start Runs Foodie in production mode
package Builds Foodie binaries for your operating system
package:mac Builds Foodie binaries for macOS
package:win Builds Foodie binaries for Windows
package:linux Builds Foodie binaries for Linux
package:all Builds Foodie binaries for all operating systems

Note: more commands are available. You can see them all in package.json.

Screenshots

More on Imgur