Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/intk/volto-zeeuwsmuseum-theme

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/intk/volto-zeeuwsmuseum-theme
Owner: intk
Created: 2023-01-18T10:02:17.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2024-02-20T17:08:56.000Z (11 months ago)
Last Synced: 2024-08-02T14:05:08.374Z (5 months ago)
Language: JavaScript
Size: 3.24 MB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

awesome-volto - volto-zeeuwsmuseum-theme - Volto project for the [Zeeuws Museum](https://www.zeeuwsmuseum.nl/en) made for [INTK](https://www.intk.com/en). (Websites built with Volto / Open-source websites built with Volto)

README

# zeeuwsmuseumwebsite

[![Built with Cookiecutter Plone Starter](https://img.shields.io/badge/built%20with-Cookiecutter%20Plone%20Starter-0083be.svg?logo=cookiecutter)](https://github.com/collective/cookiecutter-plone-starter/)
[![Black code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
[![Backend Tests](https://github.com/intkbv/zeeuwsmuseumwebsite/actions/workflows/backend.yml/badge.svg)](https://github.com/intkbv/zeeuwsmuseumwebsite/actions/workflows/backend.yml)
[![Frontend Tests](https://github.com/intkbv/zeeuwsmuseumwebsite/actions/workflows/frontend.yml/badge.svg)](https://github.com/intkbv/zeeuwsmuseumwebsite/actions/workflows/frontend.yml)

A new project using Plone 6.

## Quick start

### Development Setup

- Python 3.9
- Node 16
- yarn
- Docker

### Install

```shell
git clone [email protected]:intkbv/zeeuwsmuseumwebsite.git
cd zeeuwsmuseumwebsite
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 zeeuwsmuseumwebsite
- **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-01-18 09:32:16**