https://github.com/dev-murphy/sda-hymns-app
Welcome to the SDA Hymns App! This project is built with Vue 3 and Tailwind CSS, providing a modern and responsive user interface for accessing hymns.
https://github.com/dev-murphy/sda-hymns-app
hymnal tailwindcss vue3-typescript
Last synced: about 2 months ago
JSON representation
Welcome to the SDA Hymns App! This project is built with Vue 3 and Tailwind CSS, providing a modern and responsive user interface for accessing hymns.
- Host: GitHub
- URL: https://github.com/dev-murphy/sda-hymns-app
- Owner: dev-murphy
- Created: 2025-01-08T03:35:07.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-01-29T12:00:08.000Z (4 months ago)
- Last Synced: 2025-01-29T12:33:58.220Z (4 months ago)
- Topics: hymnal, tailwindcss, vue3-typescript
- Language: Vue
- Homepage: https://sda-hymns-app.vercel.app
- Size: 1.03 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# ⛪ SDA Hymnal App
Welcome to the SDA Hymns App! This project is built with Vue 3 and Tailwind CSS, providing a modern and responsive user interface for accessing hymns.
## 🚀 Features
- Browse and search through a collection of hymns
- Responsive design for optimal viewing on all devices
- Multiple color modes support
- Simple and intuitive user interface
- MIDI/Audio for most hymns
- Present mode for live worship
## 💻 Tech Stack
- **Vue 3 [Typescript]**: Web framework for building user interfaces powered up by typescript
- **Vite**: Next generation frontend tooling for fast development and building
- **Tailwind CSS**: Utility-first CSS framework for rapid UI development
- **Pinia**: Intuitive, type safe, and flexible Vue Store
- **VueUse**: Collection of essential Vue Composition Utilities
- **Dexie.js**: Minimalistic IndexedDB wrapper for client-side storage
- **Fuse.js**: Lightweight fuzzy-search library
- **PWA Support**: Progressive Web App capabilities for offline access
- **Vue Router**: Official router for Vue.js applications
## 📝 What am I working on?
You can see what I am currently working on by checking the [TODO file](.todo) located in the root directory of the project. This file contains a list of tasks and features that are currently in progress or planned for future development.
## 🛠️ Installation
To get started with the SDA Hymns, follow these steps. **Please Note**: For this project, I am using `bun` from the package manager, if you prefer `yarn`, `pnpm` or `npm`, just replace `bun` in the commands below with either `yarn`, `npm {run}` or `pnpm` respectfully.
### Clone the repository
```sh
git clone https://github.com/dev-murphy/sda-hymns.git
cd sda-hymns
```
### Install dependencies
```sh
bun install
```
### Start the development server
```sh
bun dev
```
### Build and Type-check for Proudnction
```sh
bun build
```
### Run preview the Proudnction
```sh
bun preview
```
Open your browser and navigate to `http://localhost:5173`.