search

oaeproject / Biscuit-ux

Band new advanced modern shiny and experimental frontend for OAE
1 stars 3 forks source link

readme

Biscuit-ux

This is an experimental frontend for Apereo's Open Academic Environment. In time this will implement the new design for OAE and connect to the backend.

Status

FOSSA Status Known Vulnerabilities

code style XO code style Conventional Commits Semver datree-badge

Development

This project is based on the Polymer project PWA starter kit so feel free to check its documentation online. With time Biscuit-ux will slowly drop most of the built-in functionality and become its own project.

To kickstart development:

  1. git clone https://github.com/oaeproject/Biscuit-ux.git && cd Biscuit-ux
  2. yarn
  3. npm run start:webpack

Integration with Hilary

Integration with the backend is still experimental and requires a few changes to Hilary. One must use Hilary's biscuit-ux-integration branch and change the nginx.conf file linked in docker-compose.yml to the one this project provides (check folder dev-utils). Restart oae-nginx docker to make sure the config is loaded:

  1. docker-compose stop oae-nginx
  2. docker-compose rm -f oae-nginx
  3. docker-compose up -d oae-nginx
  4. docker-compose logs -f oae-nginx

License

FOSSA Status

Help

Find us on discord.