diff --git a/DEVELOP.md b/DEVELOP.md index 9a480dd..0140106 100644 --- a/DEVELOP.md +++ b/DEVELOP.md @@ -4,50 +4,24 @@ Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/) -1. Install `mrs.developer` +1. Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer` - $ npm install -g mrs.developer - -1. Install `@plone/create-volto-app` - - $ npm install -g @plone/create-volto-app + $ npm install -g yo + $ npm install -g @plone/generator-volto + $ npm install -g mrs-developer 1. Create new volto app - $ create-volto-app my-volto-project + $ yo @plone/volto my-volto-project --addon @eeacms/volto-columns-block $ cd my-volto-project -1. Update `package.json` with the following information: - - { - "private": true, - - "workspaces": [ - "src/addons/volto-columns-block" - ], - - "scripts": { - "develop": "missdev --config=jsconfig.json --output=addons" - }, - - "addons": [ - "@eeacms/volto-blocks-form", - "@eeacms/volto-columns-block" - ], - - "dependencies": { - "@plone/volto": "8.2.0", - "@eeacms/volto-blocks-form": "github:eea/volto-blocks-form#0.5.0" - }, - } - 1. Add the following to `mrs.developer.json`: { "volto-columns-block": { "url": "https://github.com/eea/volto-columns-block.git", "package": "@eeacms/volto-columns-block", - "branch": "master", + "branch": "develop", "path": "src" } } @@ -59,7 +33,7 @@ Before starting make sure your development environment is properly set. See [Vol 1. Start backend - $ docker run -d --name plone -p 8080:8080 -e SITE=Plone plone:5 + $ docker run -d --name plone -p 8080:8080 -e SITE=Plone plone ...wait for backend to setup and start - `Ready to handle requests`: diff --git a/README.md b/README.md index c40ac11..f998cd8 100644 --- a/README.md +++ b/README.md @@ -23,22 +23,22 @@ blocks container. 1. Create new volto project if you don't already have one: ``` - $ npm install -g @plone/create-volto-app - $ create-volto-app my-volto-project + $ npm install -g yo @plone/generator-volto + $ yo @plone/volto my-volto-project --addon @eeacms/volto-columns-block + $ cd my-volto-project + $ yarn add -W @eeacms/volto-columns-block ``` -1. Update `package.json`: +1. If you already have a volto project, just update `package.json`: ```JSON "addons": [ - "@eeacms/volto-blocks-form", "@eeacms/volto-columns-block" ], "dependencies": { - "@eeacms/volto-blocks-form": "github:eea/volto-blocks-form#0.5.0", - "@eeacms/volto-columns-block": "github:eea/volto-columns-block#0.2.0" + "@eeacms/volto-columns-block": "^1.0.0" } ``` diff --git a/bootstrap b/bootstrap index 77a8f16..8b2c40f 100644 --- a/bootstrap +++ b/bootstrap @@ -23,7 +23,7 @@ fs.readdir(".", { withFileTypes: true }, (err, dirents) => { .filter(dirent => dirent.isFile()) .map(dirent => dirent.name); files.forEach(function (file) { - if (file != 'bootstrap.js') { + if (file != 'bootstrap') { bootstrap(file); } }); diff --git a/package.json b/package.json index f5ca236..2089a51 100644 --- a/package.json +++ b/package.json @@ -3,18 +3,34 @@ "version": "0.3.7", "description": "volto-columns-block: Volto add-on", "main": "src/index.js", - "repository": "https://github.com/eea/volto-columns-block", "author": "European Environment Agency: IDM2 A-Team", "license": "MIT", - "devDependencies": { - "release-it": "*" - }, - "scripts": { - "release": "release-it", - "bootstrap": "node bootstrap" - }, + "homepage": "https://github.com/eea/volto-columns-block", + "keywords": [ + "volto-addon", + "volto-block", + "volto-columns", + "volto", + "plone", + "react" + ], "dependencies": { "@eeacms/volto-blocks-form": "^1.0.0", "react-color": "~2.18.1" + }, + "repository": { + "type": "git", + "url": "git@github.com:eea/volto-columns-block.git" + }, + "scripts": { + "release": "release-it", + "bootstrap": "node bootstrap", + "stylelint": "../../../node_modules/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}'", + "stylelint:overrides": "../../../node_modules/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides'", + "stylelint:fix": "yarn stylelint --fix && yarn stylelint:overrides --fix", + "prettier": "../../../node_modules/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,json,css,less,md}'", + "prettier:fix": "../../../node_modules/.bin/prettier --single-quote --write 'src/**/*.{js,jsx,json,css,less,md}'", + "lint": "../../../node_modules/eslint/bin/eslint.js --max-warnings=0 'src/**/*.{js,jsx}'", + "lint:fix": "../../../node_modules/eslint/bin/eslint.js --fix 'src/**/*.{js,jsx}'" } }