Modern Gurbani Web App NOTE: The application is still in active development and is not fit for public release just yet.
I've added several new goals and roadmap. Would love some support to make this a reality.
- Create a web app Gurbani application with lightweight modern design.
- Provide a clean way of representing Baani on Web (Usage of markdown files).
- Promote Sikhi among youth by use of technology, gamification and what not.
Well I'm a Sikh and I happen to be a web developer, so I saw an opportunity to use my skills to serve to my fellow Sikh brothers and sisters. Apart from that, the main reason behind the project is that the Baani softwares are of 1990s era in 2010s. They are in dire neeed of a revamp, and this I believe is the first step towards a modern revolution for Sikhism, when youth uses technology to learn more about Baani and Sikhism.
The application is very simple as of now. I've manually taken docs from SikhNet and gurbaninow.com and other sources. Can not thank them enough. Nitnem baanies are converted to markdown files. The reason why I chose markdown is because they are
- very lightweight
- can be parsed to HTML very easily
- can be formatted right in code
- is pretty widely supported
A CSS class gurbani-text
is used to use proper [Gurmukhi Fonts] (/dist/fonts/) for text having Gurbani. Thanks to the designer of font once again.
You can contribute by
- Reporting Issues.
- Becoming a code-collaborator.
- Becoming a content-collaborator.
The project is uses React, ES2015+, hence a bundler + transpiler is used in the build process.
# Installation
git clone https://github.com/bogas04/SikhJS.git
cd SikhJS
npm i
# Transpile JSX to JS during development
npm run build:webpack
# Transpile JSX to JS during development and watch the files
npm run build:watch
Plans, Changelog and Bugs
- Gurudwara finder #46.
- Curated by availability of langar, rooms, etc
- Moderated commenting on any selected text to promote global level vichaar.
- Notifications for same.
- Tech Improvements:
- Use Service Worker for offline support. #25.
- Optimize Components.
- Highly responsive design.
- Notifications
- Nitnem Alert (With stats like "It took you 15 minutes to do Japji yesterday. You can spare that much time")
- Calendar Alert
- CSS Beautification of Granth, Shabads and Angs.
- New Content:
- Additional Granths #39.
- Introduction to all forms Shashtars
- Shashtar Maala with pictures and descriptiosn would be amazing
- Introduction to all forms and styles of kirtan.
- SoundCloud integration for Shabads.
- YouTube integration for Shabads.
- Saakhis
- Need to add credible Saakhis which actually do akaal ustat and detach from physical form of Gurus.
- Picture Gallery
- Shabad Kosh
- Pronunciation of the words.
- Definition of words. Select a word and to get its meaning
- Bookmarks and Sehaj Path tracker #20.
- Find a way to keep data persistent even with version updates.
- Improve API routes to leverage browser keywords.
-
/sggs/1234
opens 1234 Ang. -
/shabads/mnbmj
opens Search Results for mnbmj (Mohe Na Bisaaro). -
/shabad/1234
opens 1234 Shabad.
-
- Proper searching (Thanks to GurbaniNow).
- Use react.
- Sri Guru Granth Sahib.
- Ang numbers.
- Quick select angs.
- Sikh calendar.
- Beautify.
- Complete Gurmukhi Nitnem.
- Baanis stored as markdown files for easier parsing.
- The project pivoted from being an Electron app to being a web-app in favour of Progressive Web Apps and Add To Desktop features.
- You can still download the binary however.
Thanks to
- Guru Sahib for giving me talent and skill.
- GurbaniNow.
- Sikher.com for SGGS [api.sikher.com] (http://api.sikher.com).
- Documents from:
- SikhNet for the actual [Baanies] (http://www.sikhnet.com/DownloadBanis).
- [GurbaniFiles.org] (http://www.gurbanifiles.org/).
- [SearchGurbani.com] (http://searchgurbani.com/).
- and everyone else who are making this possible.
MIT