Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 1.83 KB

README.md

File metadata and controls

70 lines (43 loc) · 1.83 KB
Raw

Aion

Aion Build Status codebeat badge

An e-learning platform written in Elixir and Elm based on real-time gameplay.

Prerequisites

If you want to run the project in a docker container you need to install:

  • docker
  • docker-compose

If you want to run it locally:

  • elixir
  • npm
  • postgres
  • python3 (only if you want to seed the database with prepared data)

Installing

You can run the project both in a docker container or locally.

To run in a docker container:

make docker-build && make docker-start

To run locally:

make development

In both cases the platform should be accessible at localhost:4000

Running the tests

To run the tests before pushing to the remote you can simply run:

make test

Built With

  • Phoenix - The web framework used
  • Elm - Used to write frontend

Contributing

Check out our CONTRIBUTING.md

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Initial database was provided by 5th August Witkowski High School in Kraków. One of the main goals of the project was to rebuild JPKS, a simple system with similar functionality, which was once a source of entertainment and knowledge for many High School students.