Giter VIP home page Giter VIP logo

elmsln / haxcms Goto Github PK

View Code? Open in Web Editor NEW
123.0 22.0 49.0 201.13 MB

HAX with a lightweight CMS backend to manage your microsite universe

Home Page: https://oer.hax.psu.edu/bto108/sites/haxcellence/documentation

License: Apache License 2.0

PHP 46.32% HTML 8.43% Shell 3.37% Dockerfile 0.28% JavaScript 41.47% CSS 0.13%
cms haxcms haxtheweb hax webcomponents course edtech education elms js lms ngdle php publishing website

haxcms's Introduction

Deploy #HAXTheWeb

HAX

The authoring experience of HAX and the ability to make fast, static file backed websites rapidly. Get all the details you want on HAXTheWeb.org! HAX seeks to be the smallest possible back-end CMS to make HAX work and be able to build websites with it. Leveraging JSON Outline Schema, HAX is able to author multiple pages, which it then writes onto the file system. This way a slim server layer is just for basic authentication, knowing how to save files, and placing them in version control.

Features

  • All the UX of HAX brought to a small CMS
  • Incredibly simple, readable file structure of flat HTML files and lightning fast, high scale micro-sites
  • cdn friendly configuration
  • 0 config, 100% offline capable, PWA generation
  • clean, simple theme layer abstracted from content
  • No database (simple .json files help manage relationships, all pages html+webcomponents)
  • Files you can reach out and touch, fork, and theme with ease!
  • Support for multiple sites
  • automatic git repo creation and management (never touch commandline again, but dive in if you really needed)
  • Built in gh-pages publishing
  • Support for PHP and Express based backends

Hosted solutions

Reclaim Hosting / Cloud

HAXiam

  • HAX can also be installed in a "HAXiam" configuration where institutional users automatically get their own HAX spaces to work in by logging in.
  • Contact via issue queue if interested in this solution and collaborating to improve it's deployment methodology

Requirements (PHP)

  • Supports PHP 7.4+
  • Requires zip, gd, and xml modules be installed
  • Apache 2.4

Requirements (node, still in development)

cd system/backend/nodejs
yarn run dev

Quick Install

$ curl -fsSL https://raw.githubusercontent.com/elmsln/HAXcms/master/scripts/haxcmsme.sh -o haxcmsme.sh && sh haxcmsme.sh

Installation Guides

Containers

  • Clone this repo: git clone https://github.com/elmsln/haxcms.git
  • Install a server container (recommended). Here are some options (We support 'em all!):
  • Open a terminal window, go to the directory where you downloaded your container app and type ddev start (for ddev) or fin init (for docksal) or lando start && lando magic (for lando) or vagrant up (for vagrant).
  • Go to the link any of them give you in a browser.
  • Username/password is admin/admin to get building out static sites locally that you can push up anywhere!
  • Click the icon in the top-right and you're off and running!

MAMP

Scope

Generate .html files which have only "content" in them. Meaning the contents of the page in question. A simple method of adding new pages and managing the organization of those pages into a simple hierarchy (outline). Support for multiple mini web sites so that you can write a lot about different topics. HAXcms is only intended to be a micro-site generator and play nicely with the rest of the HAX ecosystem without needing a monster CMS in order to utilize it.

Usage

Go to yoursite.com and login with the username and password you entered in the _config/config.php by clicking on the login icon

Windows

Cygwin command line is lightly tested, but slower than true Bash environment.

Windows Install

To properly configure git endlines for Windows, run this configuration

$ git config --global core.autocrlf true

Fedora (31/32) Troubleshooting

Newer versions of Fedora use cgroupsv2 which is currently not supported by Docker. To avoid a cgroup error before running HAX locally (e.g. before using "ddev start" or "fin init") run the following commands.

sudo mkdir /sys/fs/cgroup/systemd
sudo mount -t cgroup -o none,name=systemd cgroup /sys/fs/cgroup/systemd

License

Apache 2.0

haxcms's People

Contributors

btopro avatar cgldevel avatar chationary avatar christianmurphy avatar collinkleest avatar degarmotech avatar dependabot[bot] avatar ericjgruber avatar heymp avatar mcgarvelcuddy avatar mortenson avatar nishiscis avatar renovate-bot avatar renovate[bot] avatar thereal54 avatar timmmmyboy avatar webuxr avatar zlstravel avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.