Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 4.29 KB

README.md

File metadata and controls

105 lines (70 loc) · 4.29 KB
Raw

Europa Museum — Craft CMS Demo

Europa Museum homepage

Overview

Europa is a fictitious art museum website build with Craft CMS. This repository houses the source code for our demo, which you can try for yourself by visiting craftcms.com/demo.

We’ve also included instructions below for setting up the demo in a local development environment with Docker Compose and DDEV.

Europa shows off many of Craft’s core features and includes some popular plugins to spark your curiosity.

Development Technologies

Read more about Craft’s technical requirements in the official documentation.

Warning

This branch uses a beta version of Craft 5. Use it to explore the new features ahead of a stable release!

Front End Dependencies

Europa’s front-end was built with modern Javascript and CSS tools. Craft itself has no rules about how you structure your front-end code—so we’ve taken the opportunity to share a handful of techniques that couple Twig templates with front-end interactivity.

Local Development

This repository is ready to use with Docker Compose and DDEV.

Tip

If you’re using a different local environment, see Craft’s Server Requirements and Installation Instructions.

Docker Compose

We test demo projects in automated pipelines, so the project is ready to go if you have Docker Compose installed! The Makefile contains all the steps to boot up the project:

# Create containers and install dependencies:
make init
# Restore the bundled database backup:
make restore

You can use the CLI to create a new user, as well:

docker-compose exec web php craft users/create --admin

Tip

Visit the control panel in your running project http://localhost:8080/admin!

DDEV

DDEV is our recommended local development environment, for Craft developers at any level of experience. Our quick-start guide covers this process in detail—but we’ve done the config for you, so all that’s required is…

git clone https://github.com/craftcms/europa-museum.git
cd europa-museum
ddev start
ddev craft db/restore seed.sql

As with the vanilla Docker setup process, you can create a user for yourself with the CLI:

ddev craft users/create --admin
# ...
ddev launch admin

Front End

Run npm install with Node 14.15.0 or later.

If you use a different site URL, update DEFAULT_SITE_URL in .env or the production build process will fail:

DEFAULT_SITE_URL=https://europa.ddev.site

You can then run any of the development scripts found in package.json:

  • npm run watch to watch and automatically recompile assets for local development
  • npm run sync to watch files and reload with BrowserSync for local development
  • npm run dev to compile assets for local development
  • npm run prod to compile optimized assets for production

License

The source code of this project is licensed under the BSD Zero Clause License unless stated otherwise.

The imagery used by this project is the property of each respective license holder. You are not free to use it for your own projects.