Skip to content

gita/bhagavad-gita-graphql

Repository files navigation

Logo

Bhagavad Gita GraphQL API

Code for the BhagavadGita.io GraphQL API, which is an app built for Gita readers by Gita readers.

LICENSE Docs Stars

Usage

The Bhagavad Gita GraphQL API allows any developer to use content from Gita in their apps.

Documentation for this API is available here: GraphiQL UI

How it works?

We are using PostGraphile to instantly spin up a GraphQL API from our PostgreSQL database.

Projects

Here is a list of interesting projects using this API.

Have you build something with this API ? Open a "Show and tell" discussion. The maintainers will feature your project on the README if they find it interesting.

Self Hosting

The official API is free to use for all. But If you wish you can self host anywhere you want.

If you want to deploy your own instance,You can deploy the API server on your system or VPS using docker:

docker-compose -f docker-compose.prod.yml up --build -d

Now open http://localhost:5433/graphiql to see the docs. To stop the server, press Ctrl + C on your keyboard.

Configuration

Here is the list of supported environment variables.

Name Description Default
DATABASE_URI The DSN for your database connection. postgres:// (PostgresQL db)

To set the environment variables, you may simply use a .env file where you specify the values in the format of KEY=VALUE.

Development

Feel free to use the issue tracker for bugs and feature requests.

Looking to contribute code? PRs are most welcome!

Community

Join the Discord chat server and hang out with others in the community.