Skip to content

Latest commit

 

History

History
122 lines (78 loc) · 2.55 KB

DEVELOP.md

File metadata and controls

122 lines (78 loc) · 2.55 KB
Raw

volto-slate-dataentity

Develop

  1. Make sure you have docker and docker compose installed and running on your machine:

    git clone https://github.com/eea/volto-slate-dataentity.git
cd volto-slate-dataentity
git checkout -b bugfix-123456 develop
make
make start

  2. Wait for Volto started at 0.0.0.0:3000 meesage

  3. Go to http://localhost:3000

  4. Initialize git hooks

    yarn prepare

  5. Happy hacking!

Or add @eeacms/volto-slate-dataentity to your Volto project

Before starting make sure your development environment is properly set. See Volto Developer Documentation

  1. Install mrs.developer

     $ npm install -g mrs.developer

  2. Install @plone/create-volto-app

     $ npm install -g @plone/create-volto-app

  3. Create new volto app

     $ create-volto-app my-volto-project
 $ cd my-volto-project

  4. Update package.json with the following information:

     {
     "scripts": {
         "develop": "missdev --config=jsconfig.json --output=addons"
     },

     "addons": [
         "@eeacms/volto-slate-dataentity"
     ],
 }

  5. Add the following to mrs.developer.json:

     {
     "volto-slate-dataentity": {
         "url": "https://github.com/eea/volto-slate-dataentity.git",
         "package": "@eeacms/volto-slate-dataentity",
         "branch": "develop",
         "path": "src"
     }
 }

  6. Install

     $ make develop
 $ yarn

  7. Start backend

     $ docker run -d --name plone -p 8080:8080 -e SITE=Plone plone

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

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

  8. Start frontend

     $ yarn start

  9. Go to http://localhost:3000

  10. Happy hacking!

     $ cd src/addons/volto-slate-dataentity/

Cypress

To run cypress locally, first make sure you don't have any Volto/Plone running on ports 8080 and 3000.

You don't have to be in a clean-volto-project, you can be in any Volto Frontend project where you added volto-slate-dataentity to mrs.developer.json

Go to:

cd src/addons/volto-slate-dataentity/

Start:

make
make start

This will build and start with Docker a clean Plone backend and Volto Frontend with volto-slate-dataentity block installed.

Open Cypress Interface:

make cypress-open

Or run it:

make cypress-run