volto-slate-dataentity

October 10, 2023 · View on GitHub

Develop

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

Wait for Volto started at 0.0.0.0:3000 meesage
Go to http://localhost:3000
Initialize git hooks
```
yarn prepare
```
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

Install mrs.developer
```
 $ npm install -g mrs.developer
```

Install @plone/create-volto-app

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

Create new volto app

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

Update package.json with the following information:

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

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

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"
     }
 }

Install
```
 $ make develop
 $ yarn
```
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
Start frontend
```
 $ yarn start
```
Go to http://localhost:3000

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