generated from eea/volto-addon-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 2639e00
Showing
27 changed files
with
1,691 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
const defaultBabel = require('@plone/volto/babel'); | ||
|
||
function applyDefault(api) { | ||
const voltoBabel = defaultBabel(api); | ||
voltoBabel.plugins.push('@babel/plugin-transform-modules-commonjs', 'transform-class-properties', 'istanbul'); | ||
return voltoBabel; | ||
} | ||
|
||
module.exports = applyDefault; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
.vscode/ | ||
.history | ||
.eslintrc.js | ||
project | ||
logs | ||
*.log | ||
npm-debug.log* | ||
.DS_Store | ||
*.swp | ||
yarn-error.log | ||
yarn.lock | ||
package-lock.json | ||
|
||
node_modules | ||
build | ||
dist | ||
cypress/videos | ||
cypress/reports | ||
screenshots | ||
videos | ||
.env.local | ||
.env.development.local | ||
.env.test.local | ||
.env.production.local | ||
*~ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
const fs = require('fs'); | ||
const path = require('path'); | ||
|
||
const projectRootPath = fs.realpathSync('./project'); // __dirname | ||
const packageJson = require(path.join(projectRootPath, 'package.json')); | ||
const jsConfig = require(path.join(projectRootPath, 'jsconfig.json')).compilerOptions; | ||
|
||
const pathsConfig = jsConfig.paths; | ||
|
||
let voltoPath = path.join(projectRootPath, 'node_modules/@plone/volto'); | ||
|
||
Object.keys(pathsConfig).forEach(pkg => { | ||
if (pkg === '@plone/volto') { | ||
voltoPath = `./${jsConfig.baseUrl}/${pathsConfig[pkg][0]}`; | ||
} | ||
}); | ||
const AddonConfigurationRegistry = require(`${voltoPath}/addon-registry.js`); | ||
const reg = new AddonConfigurationRegistry(projectRootPath); | ||
|
||
// Extends ESlint configuration for adding the aliases to `src` directories in Volto addons | ||
const addonAliases = Object.keys(reg.packages).map(o => [ | ||
o, | ||
reg.packages[o].modulePath, | ||
]); | ||
|
||
|
||
module.exports = { | ||
extends: `${projectRootPath}/node_modules/@plone/volto/.eslintrc`, | ||
settings: { | ||
'import/resolver': { | ||
alias: { | ||
map: [ | ||
['@plone/volto', '@plone/volto/src'], | ||
...addonAliases, | ||
['@package', `${__dirname}/src`], | ||
['~', `${__dirname}/src`], | ||
], | ||
extensions: ['.js', '.jsx', '.json'], | ||
}, | ||
'babel-plugin-root-import': { | ||
rootPathSuffix: 'src', | ||
}, | ||
}, | ||
}, | ||
}; | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
{ | ||
"npm": { | ||
"publish": false | ||
}, | ||
"git": { | ||
"changelog": "npx auto-changelog --stdout --commit-limit false -u --template https://github.com/raw/release-it/release-it/master/templates/changelog-compact.hbs", | ||
"tagName": "${version}" | ||
}, | ||
"github": { | ||
"release": true, | ||
"releaseName": "${version}", | ||
"releaseNotes": "npx auto-changelog --stdout --commit-limit false -u --template https://github.com/raw/release-it/release-it/master/templates/changelog-compact.hbs" | ||
}, | ||
"hooks": { | ||
"after:bump": "npx auto-changelog --commit-limit false -p" | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Changelog | ||
|
||
## 0.1.0 | ||
|
||
- Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# volto-addon-template | ||
|
||
## Develop | ||
|
||
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` | ||
|
||
npm install -g yo @plone/generator-volto mrs-developer | ||
|
||
1. Create new volto app | ||
|
||
yo @plone/volto my-volto-project --addon @eeacms/volto-addon-template --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", | ||
"branch": "develop", | ||
"path": "src" | ||
} | ||
} | ||
|
||
1. Install | ||
|
||
yarn develop | ||
yarn | ||
|
||
1. Start 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 | ||
|
||
yarn start | ||
|
||
1. Go to http://localhost:3000 | ||
|
||
1. Happy hacking! | ||
|
||
cd src/addons/volto-addon-template/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# <%= name %> | ||
|
||
## Develop | ||
|
||
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` | ||
|
||
npm install -g yo @plone/generator-volto mrs-developer | ||
|
||
1. Create new volto app | ||
|
||
yo @plone/volto my-volto-project --addon <%= addonName %> --skip-install | ||
cd my-volto-project | ||
|
||
1. Add the following to `mrs.developer.json`: | ||
|
||
{ | ||
"<%= name %>": { | ||
"url": "https://github.com/eea/<%= name %>.git", | ||
"package": "<%= addonName %>", | ||
"branch": "develop", | ||
"path": "src" | ||
} | ||
} | ||
|
||
1. Install | ||
|
||
yarn develop | ||
yarn | ||
|
||
1. Start 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 | ||
|
||
yarn start | ||
|
||
1. Go to http://localhost:3000 | ||
|
||
1. Happy hacking! | ||
|
||
cd src/addons/<%= name %>/ |
Oops, something went wrong.