Skip to content

Sample project built on top of the Websight CMS Community Edition

License

Notifications You must be signed in to change notification settings

marekczajkowski/starter

 
 

Repository files navigation

CI

WebSight Starter

WebSight Starter is a sample project built on top of the Websight CMS Community Edition. It contains a demo page called Luna built with Howlite components.

Playground

Set up a local on-demand environment with the released WebSight CMS CE Docker images by running:

curl https://www.websight.io/scripts/get.sh | sh

and then see the results on localhost:8080/apps/websight/index.html/content::spaces (credentials are wsadmin/wsadmin).

Luna screenshot

For more details see our Authoring Quick Start Guide.

Websight Technologies

Find out what technologies Dynamic Solutions team have used to design, build and launch WebSight.

CMS

Websight CMS makes use of the following technologies:

Java OSGi Apache Sling Apache Jackrabbit ReactJS TypeScript nginx MongoDB

CMS Runtime

The following technologies are used for running WebSight:

AWS Docker

CMS Supportive

The following technologies are used to support the process of delivery:

Bash Maven Cypress Percy.io Bitbucket Github Actions Confluence Jira YAML

Design and Prototype

The following technologies are used in designing and prototyping:

Figma Miro

Development

Prerequisites

How to build

Run the command

./mvnw clean verify -P e2e

to build the sample websight, aggregate all required CMS dependencies, run end-to-end tests with Cypress, build Docker images (ds/nginx-luna:latest, ds/websight-cms-luna:latest).

How to run

Once Docker images are ready, all you need is to run Docker Compose from the environment/local folder:

docker compose up

CMS is available under: localhost:8080/apps/websight/index.html/content::spaces (credentials are wsadmin/wsadmin).

Pages published from Luna space are available under luna.127.0.0.1.nip.io

Pages published from Bulma - Personal Template space are available under bulma.127.0.0.1.nip.io

Project structure

  • application - components related code and scripts
    • backend - contains application elements (components, templates, etc.) and Java code
  • content - contains sample content created with use of application
  • distribution - builds a distribution of the project - instance feature model and docker images for runtime components
  • environment - contains scripts and files used but build environment
    • local - starts local environment
  • tests - responsible for the automatic distribution validation
    • content - contains content used for end to end tests
    • end-to-end - end-to-end tests validating distribution

Contributing

Please read our Contributing Guide before submitting a Pull Request to the project.

Community support

To support us, you may follow the project at:

Documentation

See our dedicated repository for the WebSight CMS documentation, or view our documentation live:

License

WebSight Starter and Howlite components are open-source with Apache License 2.0 license.

WebSight CMS Community Edition is free to use for everyone (terms of use).

About

Sample project built on top of the Websight CMS Community Edition

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 44.9%
  • Java 18.9%
  • Shell 13.7%
  • HTML 12.4%
  • Dockerfile 10.1%