Welcome to the official repository of Sigil, a state-of-the-art companion application designed specifically for the Sigil Live Action Role Playing (LARP) game. Built using the Ionic Framework with Vue3 and Vuex, Sigil aims to enhance your LARP experience by providing seamless integration and utility both in and out of game sessions. Below, you'll find instructions on how to get started with the project, along with links to additional resources and documentation.
- Getting Started
- Project Structure
- Continuous Deployment
- Lambda Functions
- Docker
- Contributing
- License
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Before you begin, ensure you have the following tools installed on your system:
- Node.js and npm
- Ionic CLI
- Docker (for building and running Docker images)
- Vue CLI (optional)
-
Clone the repository to your local machine:
git clone https://github.com/biscuitWizard/Sigil.git cd Sigil -
Install the project dependencies:
npm install
-
Serve the application locally:
ionic serve
Navigate to http://localhost:8100 to view the application.
Sigil's codebase is organized for clarity and scalability. For a detailed explanation of the project structure and conventions used, visit the Project Structure Wiki.
Sigil uses modern CI/CD practices for automated testing and deployment. For more details on our continuous deployment strategy and how to set it up for your forks, refer to the Continuous Deployment Wiki.
The /lambda folder contains various AWS Lambda functions used by Sigil for backend processing and integration tasks. Each function is documented with its purpose, inputs, and outputs. For more information, visit the Lambda Functions Wiki.
Sigil can be built and run as a Docker container for ease of deployment and consistency across environments.
To build the Docker image:
docker build -t sigil:latest .To run the Docker container:
docker run -d -p 8100:8100 sigil:latestFor detailed instructions on setting up and managing Docker for Sigil, including optimizations and deployment, see the Docker Wiki.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make to the Sigil project are greatly appreciated. Check out our Contributing Guide for more information on how to get started.
This project is licensed under the MIT License - see the LICENSE.md file for details.