Hilary is the back-end for the Open Academic Environment. The current frontend is at 3akai-ux but we're slowly building a new one, check it out: Cake
There's a docker image on docker-hub that works out of the box: https://hub.docker.com/r/oaeproject/oae-demo
If you want to build that image locally, you can do that by following instructions at https://github.com/oaeproject/oae-demo/
Here are the quick instructions on how to get OAE set up locally. There's also a more in-depth step-by-step tutorial in the wiki.
node -v # make sure you have v16+
npm -v # make sure you have 7.0.8+
git clone https://github.com/oaeproject/Hilary.git && cd Hilary
# TODO: run script to adapt config to local env
docker-compose up -d oae-cassandra oae-elasticsearch oae-redis oae-nginx
cd ethercalc && npm install && cd ..
./prepare-etherpad.sh
cd 3akai-ux && npm install
npm run migrate ; npx pm2 startOrReload process.json ; npx pm2 logs
To run tests just make sure you have installed all dependencies (check wiki page on how to set up a dev environment) and run npm run test
. To run tests on a specific module, just append its path as follows: npm run test-module packages/oae-principals/tests
.
The project website can be found at http://www.oaeproject.org. The project blog will be updated with the latest project news from time to time.
The mailing list used for Apereo OAE is [email protected]. You can subscribe to the mailing list at https://groups.google.com/a/apereo.org/d/forum/oae.
Bugs and other issues can be reported in our issue tracker and we're always available to help in our discord channel.