Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.11 KB

README.md

File metadata and controls

71 lines (46 loc) · 2.11 KB
Raw

2023.ploneconf.org

Built with Cookiecutter Plone Starter Black code style Backend Tests Frontend Tests

Plone Conference 2023 Website

Quick start

Development Setup

  • Python 3.11
  • Node 16
  • yarn
  • Docker

Install

git clone git@github.com:plone/2023.ploneconf.org.git
cd 2023.ploneconf.org
make install

Start

Start the Backend (http://localhost:8080/)

make start-backend

Start the Frontend (http://localhost:3000/)

make start-frontend

Structure

This mono repo is composed of two distinct codebases: Backend and Frontend.

  • backend: API (Backend) Plone installation using pip (not buildout). Includes a policy package named ploneconf.core
  • frontend: React (Volto) package named frontend

Linters and Formatting

There are some hooks to run lint checks on the code. If you want to automatically format them, in the root of this repository, run

make format

Linters commands are available in each backend and frontend folder.

make lint

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