Skip to content

bishoyroufael/hymnos

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

About

Hymnos is an app that enable Church services to present Hymns or any Liturgical text during praying. It is designed to be cross-platform as a PWA app built with React-Native (expo).

Usage

Make sure you have Python, Nodejs and npm install on your system. Please refer to NodeJs and Python

Frontend

  • Go inside the frontend/ folder using cd frontend/.
  • Run npm install.
  • Run npx expo start.
  • Navigate to localhost:8081 to see the app. You can also install the Expo Go app on your mobile and scan the QR code you see on the terminal to run the app.

Technologies used

  • zustand: global state managment.
  • expo-fonts: utilizing Google fonts inside the app.
  • nativewind: cross-platform styling using tailwindcss.
  • Dexie.js: library for managing IndexedDB database that could be used in a cross-platform way (PWA).

Backend

Backend is built using Python and fastapi for designing a simple API. uv is used to manage depenedncies.

  • Install uv using curl -LsSf https://astral.sh/uv/install.sh | sh for linux or powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" for windows.
  • Serve the backend API by running uv run fastapi dev src/main.py inside the backend/ folder.
  • In your browser navigate to http://127.0.0.1:8000/docs for the Swagger docs.

About

A Cross-platform application for showing Hymns, Liturgy, ...etc in Church Services

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors