Skip to content

Commit

Permalink
docs: Update README and DEVELOP
Browse files Browse the repository at this point in the history
  • Loading branch information
avoinea committed Sep 29, 2023
1 parent 6d345c2 commit e7a5a91
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
18 changes: 8 additions & 10 deletions DEVELOP.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,12 @@ Before starting make sure your development environment is properly set. See [Vol

1. Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`

$ npm install -g yo
$ npm install -g @plone/generator-volto
$ npm install -g mrs-developer
npm install -g yo @plone/generator-volto mrs-developer

1. Create new volto app

$ yo @plone/volto my-volto-project --addon @eeacms/volto-workflow-progress
$ cd my-volto-project
yo @plone/volto my-volto-project --addon @eeacms/volto-workflow-progress --skip-install
cd my-volto-project

1. Add the following to `mrs.developer.json`:

Expand All @@ -52,26 +50,26 @@ Before starting make sure your development environment is properly set. See [Vol

1. Install

$ make develop
$ yarn
make develop
yarn

1. Start backend

docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone -e ADDONS="eea.progress.workflow" -e PROFILES="eea.progress.workflow:default" plone/plone-backend
docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend

...wait for backend to setup and start - `Ready to handle requests`:

...you can also check http://localhost:8080/Plone

1. Start frontend

$ yarn start
yarn start

1. Go to http://localhost:3000

1. Happy hacking!

$ cd src/addons/volto-workflow-progress/
cd src/addons/volto-workflow-progress/

## Cypress

Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,14 @@

[![Workflow Progress](https://github.com/raw/eea/volto-workflow-progress/master/docs/volto-workflow-progress.gif)](https://youtu.be/MV2_23_dBkc?si=8nHRxqQmnj8yy1Cb)

## Dependencies

### Backend

- [Plone](https://plone.org/download)
- [plone.restapi](https://pypi.org/project/plone.restapi/)
- [eea.progress.workflow](https://pypi.org/project/eea.progress.workflow)

## Getting started

### Try volto-workflow-progress with Docker
Expand Down

0 comments on commit e7a5a91

Please sign in to comment.