TrayMaster

TrayMaster is a software application primarily intended for managing trays of perishable stock on shelves inside a warehouse. It has been designed following consultation and analysis of the processes currently in use at Durham Christian Partnership’s Chester-le-Street foodstore; but more generally will be applicable to many other Trussell Trust-affiliated foodbanks across the UK, as well as other sectors with physical stock located within trays where incoming stock is hard to predict. This software should complement existing workflows and aid warehouse staff in their day-to-day activities.

It was designed to allow for warehouses to be modelled digitally, with the primary aim of assisting with the existing workflows of foodstore staff by:

• Providing an efficient, flexible and intuitive stocktaking interface to maximise data collection speed
• Minimising food wastage by allowing the warehouse to be queried for trays expiring soon
• Allowing statistics and reports to be compiled from the data stored about the warehouse

User Manual

This README contains only basic project information. The full project documentation (for users, administrators and developers) can be found at https://github.com/Kacper-Lubisz/TrayMaster/blob/master/public/manual.pdf.

Installation & Usage

To install, clone this repository and run npm install. We also offer prebuilt versions on the Releases page.

The following commands are available:

• npm start: launch a local development copy of the application at localhost:3000
• npm run build: build the application for production deployment (outputs to the build directory)
• npm test: run all Jest test suites

Hosting

The project, by default, is configured to run at https://traymaster.herokuapp.com and deploy automatically to Heroku on all commits to the master branch. This is configured in static.json. There's also configuration in place for Firebase static hosting (though certain routing features won't work on static hosts): this can be found in firebase.json.

Contributing

If you wish to contribute to this project, please fork this repository and make pull requests!

The project was developed using the JetBrains WebStorm IDE, and includes configuration files for both ESLint and the built-in WebStorm code inspector. We recommend that you use both if possible.