SatyaTatva is an open source and non profit organization.
SatyaTatva is a platform that offers an engaging way to explore the timeless wisdom of Sanatan Dharma. Our website provides access to the Vedas, Upanishads, Puranas, and sacred Shlokas in a user-friendly format. In addition, SatyaTatva offers key epic books like Ramayana, Mahabharata, and more.
With support for offline access (PWA) and page-flipping UI for books, SatyaTatva is optimized for cross-device usage, bringing you the sacred knowledge of ancient texts right at your fingertips.
- Vedas: Access to all Vedas in English and Hindi.
- Puranas and Upanishads: Explore the sacred texts of Sanatan Dharma.
- Shlokas: Recite shlokas like Hanuman Chalisa, Shiv Tandav Stotram, and more.
- Books: Read epic works like Ramayana, Mahabharata, and Ram Charitramanas.
- Page-Flipping UI: A user-friendly book experience.
- PWA Support: Offline access to your favorite texts.
- Cross-Device Compatibility: Access across mobile, tablet, and desktop devices.
To get started with SatyaTatva, follow these steps to clone the repository and set up your local development environment.
- Node.js (Version 14.x or higher)
- npm (Node Package Manager)
-
Clone the repository to your local machine:
git clone https://github.com/helsinfranz/satyatatva.git cd satyatatva -
Install the necessary dependencies:
npm install
-
For the mock server (to simulate the backend functionality):
-
Navigate to the
serverfolder:cd server -
Install dependencies:
npm install
-
Start the server:
node index.js
-
-
After setting up the server, you can run the Next.js application:
npm run dev
This will start the application on http://localhost:3000.
- Visit the website and explore the Vedas, Puranas, Upanishads, Shlokas, and Books.
- For a detailed book reading experience, use the page-flipping UI.
- You can also enable offline access via PWA features for accessing content even when you’re offline.
Here's a breakdown of the project's folder structure:
satyatatva/
│
├── public/ # Public static files (images, fonts, etc.)
│ ├── logos/ # SatyaTatva logo
│ └── ...
│
├── pages/ # Next.js pages
│ ├── index.js # Home page
│ └── ... # Other page files
│
├── components/ # Reusable components (headers, footers, etc.)
│ ├── header
│ ├── footer
│ └── ... # Other shared components
│
├── server/ # Mock server (used for dummy data and testing)
│ ├── index.js # Main server file
│ └── ... # Other server-related files
│
└── package.json # Project dependencies and scripts
- The server folder simulates the backend for SatyaTatva. The mock server serves dummy PDF and simulates the fetching of data.
- To run the mock server, follow the steps mentioned in the Installation section.
To run the project locally, simply follow the steps mentioned above in the Installation section. The mock server provides simulated data and PDFs, and the front-end will fetch it to display on the website.
To create a production build, run the following command:
npm run buildThis will build your application and optimize it for production. Once the build is complete, you can start the production server:
npm run startWe use ESLint and Prettier for linting and code formatting. To run the linter:
npm run lintTo format the code:
npm run formatWe welcome contributions from the open-source community. If you'd like to contribute to SatyaTatva, please follow these guidelines:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch). - Commit your changes (
git commit -am 'Add new feature'). - Push to the branch (
git push origin feature-branch). - Create a pull request.
For detailed guidelines, check the CONTRIBUTING.md.
This project is licensed under the Apache License 2.0 - see the LICENSE file for details.
For any questions or suggestions, feel free to reach out via email at satyatatva108@gmail.com.
You can also visit our website: SatyaTatva.
Feel free to explore and contribute to SatyaTatva. We encourage feedback and suggestions to help improve the project!
This section outlines the future goals and features we aim to implement for SatyaTatva.
- Expand the Text Library: Adding more books from the Sanatan Dharma.
- User Contributions: Allow users to contribute translations, shlokas, or even their interpretations of sacred texts.
- Enhanced Search and Filtering: Implement more advanced search capabilities for users to quickly find specific verses or chapters.
- Multi-Language Support: Expand the website to support more languages, especially for texts like the Vedas and Upanishads.
- Audio Features: Include audio recitations of important texts for a more immersive experience.
- Interactive Features: Add features such as verse translation, commentary, and discussions to deepen the learning experience.
You can use our Progressive Web App (PWA) feature. Simply visit the website, and it will prompt you to add it to your home screen. Once added, you can access the content even when you're offline.
Check out the Contributing Guidelines to get started. Feel free to fork the repo, make changes, and submit a pull request!
We store each book in PDF format within the server/ directory. This ensures easy access and download for all users through API.
Yes! We encourage contributions of translations, interpretations, and additional commentary on any of the texts. Please follow our contributing guidelines.
Currently, we offer PWA support for mobile devices, ensuring that users can access the content seamlessly on any device, with offline capabilities.
Here are some known issues in the project that are being worked on:
- PDF Loading Delay: Some large PDF files may take time to load. We're working on optimizing the loading experience.
- Responsive Design on Older Devices: We are currently testing and enhancing the responsiveness for certain older devices and browsers.
- Search Functionality: The search function can sometimes yield less relevant results. We plan to improve this by implementing advanced filters and search algorithms.
We would like to extend our gratitude to the following:
- Contributors: Thanks to all the contributors for their valuable time and effort.
- Open-Source Libraries: This project uses several open-source libraries that made our work much easier. Special thanks to:
If you run into any issues or need support, you can:
- Open an issue in the GitHub repository: GitHub Issues
- Contact Us: Email us at satyatatva108@gmail.com.
We encourage open discussion and learning in our community. Join us on our official forums and community channels:
- GitHub Discussions: SatyaTatva Discussions
- Discord Server: Join our Discord for live discussions, suggestions, and support.
- SatyaTatva Blog - Read insightful articles on the meanings and importance of the sacred texts.
- License - View the open-source license under which SatyaTatva is published.
- Initial release of SatyaTatva.
- Published Vedas, Puranas, Upanishads, Shlokas, and Books in the book library.
- Added PWA support for offline access.
Thank you for exploring SatyaTatva! We are committed to bringing the wisdom of Sanatan Dharma to the world in an accessible and engaging way. Feel free to contribute, suggest new features, and help us spread the light of this ancient knowledge.
Stay connected, stay inspired!