Open Guide App

Open Guide is an open-source mobile application that makes cultural offerings digitally accessible by converting Markdown files into digital engaging experiences.

This project is funded by:

Table of Contents

• Introduction
• Features
• Installation
• Usage
• Contributing
• License
• Contact

Introduction

Open Guide is designed to transform cultural and educational content into engaging, interactive digital experiences. By leveraging the simplicity and flexibility of Markdown, content creators can easily produce and share rich multimedia guides.

Features

• Markdown Conversion: Seamlessly converts Markdown files into interactive digital content.
• React Native: Built with React Native for cross-platform compatibility.
• Bun Ignite Boilerplate: Utilizes Bun Ignite boilerplate for rapid development and performance.

Installation

To get started with Open Guide, follow these steps:

Prerequisites

• Node.js (version 18 or above)
• React Native CLI
• Bun Ignite

Steps

1. Clone the repository

   git clone https://github.com/yourusername/openguide.git
   cd openguide

2. Install dependencies

   bun install

3. Apply patches (if applicable)

   npm run patch

4. Start the application

   npm start

5. Run on your device or emulator

   npm run android # For Android
   npm run ios     # For iOS

Development Setup

This project uses Bun, but most commands should work the same with npm. To install dependencies, use:

bun install