Skip to content

Commit

Permalink
initialized volto-marine-policy
Browse files Browse the repository at this point in the history
  • Loading branch information
nileshgulia1 committed Apr 14, 2024
1 parent d4cfba5 commit 9e6cf2f
Show file tree
Hide file tree
Showing 154 changed files with 9,087 additions and 2,141 deletions.
268 changes: 265 additions & 3 deletions CHANGELOG.md

Large diffs are not rendered by default.

77 changes: 12 additions & 65 deletions DEVELOP.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,7 @@
# volto-addon-template
# volto-marine-policy

## Develop

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

```Bash
git clone https://github.com/eea/volto-addon-template.git
cd volto-addon-template
git checkout -b bugfix-123456 develop
make
make start
```

1. Wait for `Volto started at 0.0.0.0:3000` meesage

1. Go to http://localhost:3000

1. Initialize git hooks

```Bash
yarn prepare
```

1. Happy hacking!

### Or add @eeacms/volto-addon-template to your Volto project

Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)

1. Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
Expand All @@ -34,31 +10,34 @@ Before starting make sure your development environment is properly set. See [Vol

1. Create new volto app

yo @plone/volto my-volto-project --addon @eeacms/volto-addon-template --skip-install
yo @plone/volto my-volto-project --addon @eeacms/volto-marine-policy --skip-install
cd my-volto-project

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

{
"volto-addon-template": {
"url": "https://github.com/eea/volto-addon-template.git",
"package": "@eeacms/volto-addon-template",
"volto-marine-policy": {
"url": "https://github.com/eea/volto-marine-policy.git",
"package": "@eeacms/volto-marine-policy",
"branch": "develop",
"path": "src"
}
}

1. Install

make develop
yarn develop
yarn

1. Start backend

docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
docker pull plone
docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone

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

docker logs -f plone

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

1. Start frontend
Expand All @@ -69,38 +48,6 @@ Before starting make sure your development environment is properly set. See [Vol

1. Happy hacking!

cd src/addons/volto-addon-template/

## 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-addon-template` to `mrs.developer.json`

Go to:

```BASH
cd src/addons/volto-addon-template/
```

Start:

```Bash
make
make start
```

This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-addon-template` block installed.

Open Cypress Interface:

```Bash
make cypress-open
```

Or run it:
cd src/addons/volto-marine-policy/

```Bash
make cypress-run
```
n-template/
106 changes: 0 additions & 106 deletions DEVELOP.md.tpl

This file was deleted.

14 changes: 0 additions & 14 deletions Dockerfile

This file was deleted.

Loading

0 comments on commit 9e6cf2f

Please sign in to comment.