search

Abhishek-Mallick / universal-box

Project scaffolding just got easier — streamline your development with Universal-Box's pre-built templates and one-click deployment! 🚀
https://universal-box.dev
Apache License 2.0
28 stars 26 forks source link

feat:[TEMPLATE] - API template using Hasura-GraphQL #90 #134

Closed protob closed 1 month ago

protob commented 1 month ago

Description

API template using Hasura-GraphQL Fixes issue #90

Type of Change

How Has This Been Tested?

The code has been tested manually

Checklist

Additional Notes

Add any other context or information that may be helpful for the reviewers.

Summary by CodeRabbit

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
universal-box ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 13, 2024 0:44am
coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in this pull request introduce a comprehensive setup for a Hasura GraphQL API using PostgreSQL. Key additions include a new environment configuration file, Docker Compose setup, detailed documentation for GraphQL operations, and various metadata files defining the schema for a library management system. The updates encompass sample data, migration scripts for database initialization, and a new guide to facilitate users in setting up and managing their Hasura instance effectively.

Changes

File Path Change Summary
template/API/Hasura-GraphQL/.env.example New environment configuration file created with PostgreSQL and Hasura settings.
template/API/Hasura-GraphQL/README.md Added a setup and configuration guide for Hasura, including instructions for Docker and migrations.
template/API/Hasura-GraphQL/docker-compose.yaml New Docker Compose file created for Hasura and PostgreSQL services.
template/API/Hasura-GraphQL/docs.md Comprehensive GraphQL documentation for library management system queries and mutations added.
template/API/Hasura-GraphQL/hasura-exports/config.yaml New configuration file created for Hasura API with key settings.
template/API/Hasura-GraphQL/hasura-exports/metadata/actions.yaml New empty actions metadata file created.
template/API/Hasura-GraphQL/hasura-exports/metadata/allow_list.yaml New empty allow list metadata file created.
template/API/Hasura-GraphQL/hasura-exports/metadata/cron_triggers.yaml New empty cron triggers metadata file created.
template/API/Hasura-GraphQL/hasura-exports/metadata/databases/databases.yaml New PostgreSQL database configuration added.
template/API/Hasura-GraphQL/hasura-exports/metadata/databases/postgres/tables/public_authors.yaml New configuration for authors table created with relationships and permissions.
template/API/Hasura-GraphQL/hasura-exports/metadata/databases/postgres/tables/public_books.yaml New configuration for books table created with relationships and permissions.
template/API/Hasura-GraphQL/hasura-exports/metadata/databases/postgres/tables/public_genres.yaml New configuration for genres table created with relationships and permissions.
template/API/Hasura-GraphQL/hasura-exports/metadata/databases/postgres/tables/public_tags.yaml New configuration for tags table created with relationships and permissions.
template/API/Hasura-GraphQL/hasura-exports/metadata/databases/postgres/tables/public_users.yaml New configuration for users table created with relationships and permissions.
template/API/Hasura-GraphQL/hasura-exports/metadata/databases/postgres/tables/tables.yaml New include directives added for various tables in the database schema.
template/API/Hasura-GraphQL/hasura-exports/metadata/query_collections.yaml New empty query collections metadata file created.
template/API/Hasura-GraphQL/hasura-exports/metadata/remote_schemas.yaml New empty remote schemas metadata file created.
template/API/Hasura-GraphQL/hasura-exports/metadata/rest_endpoints.yaml New empty REST endpoints metadata file created.
template/API/Hasura-GraphQL/hasura-exports/metadata/version.yaml Version updated from 2 to 3 in the metadata configuration.
template/API/Hasura-GraphQL/hasura-exports/migrations/postgres/1728771962403_init/up.sql Migration script added for creating tables and functions in the PostgreSQL database.
template/API/Hasura-GraphQL/hasura-exports/sample-data.sql Sample data insertion statements added for authors, users, genres, tags, and books.
website/content/Templates/API/Hasura-GraphQL.md New guide document created for the Hasura GraphQL Server Template.

Possibly related issues

Suggested reviewers

Poem

🐰 In the garden of code, we hop and play,
With Hasura and PostgreSQL, we pave the way.
New tables and schemas, a template so bright,
For queries and mutations, we take flight!
With each little change, our project will grow,
A world of data, ready to show! 🌼📚

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.