https://github.com/intk/volto-rietveldschroderhuis-theme
new.rietveldSchroderhuis.nl
https://github.com/intk/volto-rietveldschroderhuis-theme
Last synced: 2 months ago
JSON representation
new.rietveldSchroderhuis.nl
- Host: GitHub
- URL: https://github.com/intk/volto-rietveldschroderhuis-theme
- Owner: intk
- Created: 2023-06-06T12:55:33.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-02T13:42:24.000Z (11 months ago)
- Last Synced: 2024-11-05T00:35:51.873Z (7 months ago)
- Language: JavaScript
- Size: 2.14 MB
- Stars: 1
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
- awesome-volto - volto-rietveldschroderhuis-theme - Volto project for the [Rietveld Schröder House](https://www.rietveldschroderhuis.nl/en) made for [INTK](https://www.intk.com/en). (Websites built with Volto / Open-source websites built with Volto)
README
# rietveld
[](https://github.com/collective/cookiecutter-plone-starter/)
[](https://github.com/ambv/black)
[](https://github.com/https://github.com/intk/rietveld/actions/workflows/backend.yml)
[](https://github.com/https://github.com/intk/rietveld/actions/workflows/frontend.yml)
A new project using Plone 6.
## Quick start
### Development Setup
- Python 3.9, 3.10, 3.11
- Node 16
- yarn
- Docker
### Install
```shell
git clone [email protected]:https://github.com/intk/rietveld.git
cd rietveld
make install
```
### Start
Start the Backend (http://localhost:8080/)
```shell
make start-backend
```
Start the Frontend (http://localhost:3000/)
```shell
make start-frontend
```
## Structure
This monorepo is composed by two distinct codebases: api and frontend.
- **backend**: API (Backend) Plone installation using pip (not buildout). Includes a policy package named rietveld
- **frontend**: React (Volto) package named frontend
### Reasoning
- Repo contains all codebase needed to run the site (excluding existing addons for Plone and React).
- Github Workflows are triggered based on changes on each codebase (see .github/workflows)
- Easier to create Docker images for each codebase
- Showcase Plone installation/setup without buildout
## Linters and Formatting
There are some hooks to run lint checks on the code. If you want to automatically format them, you can run
`make format`
in the root folder or especifically in each backend or frontend folders.
Linters commands are available in each backend and frontend folder.
## Acceptance tests
There are `Makefile` commands in place:
`build-test-acceptance-server`: Build Acceptance Backend Server Docker image that it's being used afterwards. Must be run before running the tests, if the backend code has changed.
`start-test-acceptance-server`: Start server fixture in docker (previous build required)
`start-test-acceptance-frontend`: Start the Core Acceptance Frontend Fixture in dev mode
`test-acceptance`: Start Core Cypress Acceptance Tests in dev mode
## Credits
**This was generated by [cookiecutter-plone-starter](https://github.com/collective/cookiecutter-plone-starter) on 2023-06-06 12:31:01**