Yumme Web
Web frontend for Yumme - a self-hosted recipe journal.
Backend service counterpart can be found here.
Development
Prerequisites
Build
To compile and package the application, simply issue the following command:
$ npm install
$ npm run build
This will bundle the application and output it in build/.
Run
To serve the application using a local development server, the following command can be used:
$ npm run start
The web server is accessible at localhost:3000.
A fake API client implementation can be used by providing a MOCK_SERVER environment variable
during build.
$ MOCK_SERVER=true npm run start
To use a real backend locally, instead provide a YUMME_SERVER environment variable:
$ YUMME_SERVER=<domain> npm run start
This will proxy all API requests in order to avoid CORS issues. In producation this environment variable is not provided, which causes API requests to target the same domain as the frontend.
Test
To run lint checks for all scripts and styles:
$ npm run lint
Or specify what to lint:
$ npm run lint:scripts
$ npm run lint:styles
To run unit tests, use:
$ npm run test
Deployment
Image creation
To create an image, run the following command in the root directory:
$ docker build . -t yumme-web
An image is created and published automatically to github packages on git tag pushes.
Contribute
Use the issue tracker to report bugs or make feature requests. Pull requests are welcome, but it may be a good idea to create an issue to discuss any changes beforehand.
License
MIT, see LICENSE file.