Rapua

Navigating learning, made easy.
See in action · Report Bug · Request Feature · Read the Docs

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

Rapua is an open-source game platform designed for place-based learning. Rapua is the culmination of two key projects: The Amazing Trace, developed as part of my Master of Science Communication thesis at the University of Otago, and Te Rapu Hamu, which I built for the Faculty of Law at the University of Otago to support their vision.

Rapua exists to make it easy to create games for education in the real world. It combines the best of both platforms, offering a powerful tool for learning that can teach complex concepts, engage diverse audiences, and create immersive, real-world educational experiences. It can be applied to a wide range of educational contexts, from university orientation and induction, staff training, and health and safety, to community engagement and public outreach.

(back to top)

Built With

Rapua is built with the GOTTH stack: Go, (SQLite), TailwindCSS, Templ, and HTMX.

(back to top)

Getting Started

To get a local copy up and running follow these simple steps. If you would prefer a hosted version, you can find it here.

Prerequisites

Ensure you have Go installed on your machine. If not, you can download it from the official website here. Make sure the version is at least what is shown in the badge above. You can check the version by running the following command in your terminal:

go version

You will also need to have SQLite installed on your machine. If you don't have it installed, you can download it from the official website here.

Installation

1. Clone the repo

   git clone https://github.com/nathanhollows/Rapua.git

2. Change into the project directory

    cd Rapua

3. Set the .env file

   cp .env.template .env

   Update the .env file with your database details

   vi .env

4. Build the project

   make build

   Other build options are available including make dev, make tailwind-build, make tailwind-watch, make templ-watch, make templ-generate, and make test.
5. Run the project

   ./rapua

6. Open your browser and navigate to http://localhost:8090

(back to top)

Usage

For examples of how to use Rapua, please refer to the Docs.

(back to top)

Roadmap

See the roadmap/wishlist for a list of proposed features. The list is not exhaustive and is subject to change. Please request a feature if you would like to see something added.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Nathan Hollows - nathan@rapua.nz

(back to top)

Acknowledgements

• The University of Otago for supporting the research and development of this project and its predecessors.
  • The Department of Science Communication for their guidance and support.
  • The Faculty of Law for the opportunity to work with them on such an exciting project.
  • The Higher Education Development Centre for their support.
  • The Locals Collegiate Community, Pacific Islands Centre, the Sub-Warden training committee, and the College of Education for their support and feedback.

(back to top)