Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dev-shetty/gitaverse
Browser Extension and Website for Bhagavad Gita
https://github.com/dev-shetty/gitaverse
api bhagavad-gita browser-extension nextjs tailwindcss typescript
Last synced: about 1 month ago
JSON representation
Browser Extension and Website for Bhagavad Gita
- Host: GitHub
- URL: https://github.com/dev-shetty/gitaverse
- Owner: dev-shetty
- License: mit
- Created: 2023-08-11T00:37:20.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-09-06T14:35:13.000Z (over 1 year ago)
- Last Synced: 2023-11-21T04:26:40.103Z (about 1 year ago)
- Topics: api, bhagavad-gita, browser-extension, nextjs, tailwindcss, typescript
- Language: TypeScript
- Homepage:
- Size: 440 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitaVerse
A browser extension, which gives a verse from Bhagavad Gita. (Future) Website for Bhagavad Gita
## Tech Stack
- Next.js
- TypeScript
- TailwindCSS
## Setup the extension
To make the extension public, I have to pay for the $5 to sign up a developer account. So I have one alternative,
1. Clone the project by running
```bash
git clone https://github.com/Deveesh-Shetty/GitaVerse.git
```
2. Open the project in your desired editor, and create a `.env` file in the root folder of the project with the following data,
```
NEXT_PUBLIC_GITA_API_KEY = "Your API KEY"
```
> The API key you can get from [rapid API](https://rapidapi.com/bhagavad-gita-bhagavad-gita-default/api/bhagavad-gita3)
3. Now install the dependencies and build the extension locally using the commands
```bash
npm ci
npm run build:extension
```
4. Once finished you will see an `out` folder that is created. The hard part is done now it's easy!
5. Go to `chrome://extensions/` in the browser and at the top-right turn on `developer mode`
6. Once you turn on developer mode, you will get three options, click `load unpacked`
8. Navigate to the folder where you have cloned the repository, select the `out` directory, and click `select`.
9. You have Successfully installed the extension! You can see **GitaVerse** in the list of extensions.
**If you faced any problem, or error while following the steps, feel free to contact me and raise an issue. I am more than ready to help!**
## Plans
- Have a website that displays the entire Bhagavad Gita in an ancient scripture like a webpage, which should feel like reading the epic itself. It would be great if someone designed it or gave some more ideas.
- My current Idea: War theme, Golden, Blue, and Royal colors, and a script-roll opening animation when the viewer clicks the verse. Book opening animation when the viewer opens the chapter.
-[x] Browser Extension will be just one part of the website (I have to figure out how to separate both the website and extension)
Open to contributions and suggestions! The project is still in the budding stage, and I would love to get help on this!!
## Browser Extension Preview
