From 3dd144fb8d54573fbfca4991cc84fb367cafce57 Mon Sep 17 00:00:00 2001 From: Igor Benav Date: Wed, 8 Jan 2025 23:35:24 -0300 Subject: [PATCH 1/2] showcase submission template, docs, readme --- .github/ISSUE_TEMPLATE/showcase-submission.md | 29 ++++++++++ README.md | 17 ++++++ docs/community/showcase_submission.md | 47 ++++++++++++++++ docs/showcase.md | 53 +++++++++++++++++++ mkdocs.yml | 2 + 5 files changed, 148 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/showcase-submission.md create mode 100644 docs/community/showcase_submission.md create mode 100644 docs/showcase.md diff --git a/.github/ISSUE_TEMPLATE/showcase-submission.md b/.github/ISSUE_TEMPLATE/showcase-submission.md new file mode 100644 index 0000000..2a45779 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/showcase-submission.md @@ -0,0 +1,29 @@ +--- +name: FastCRUD Project Showcase +about: Submit your project to be featured in the FastCRUD showcase +title: 'Showcase: ' +labels: 'showcase' +assignees: '' + +--- + +**Project Name** +The name of your project + +**Category** +Choose one: Tutorial, Open Source Project, Application, Commercial Service + +**Description** +Brief description of what your project does (2-3 sentences) + +**Author** +Your name or GitHub handle + +**Project Links** +Relevant links based on your project type (Tutorial URL, Repository, Product URL, etc.) + +**FastCRUD Features** +What FastCRUD features does your project use? (FastCRUD class, Endpoint Creator, etc.) + +**Additional Information** +Any other details you'd like to share about your project \ No newline at end of file diff --git a/README.md b/README.md index fe139f5..a0273bf 100644 --- a/README.md +++ b/README.md @@ -214,6 +214,23 @@ In this example, we define custom endpoints for creating and reading items using To read more detailed descriptions, go to the documentation. +

Showcase

+Browse our [showcase](https://igorbenav.github.io/fastcrud/showcase/) to see projects and tutorials built with FastCRUD: + +- 馃殌 **Applications**: Web apps and services powered by FastCRUD +- 馃摉 **Open Source**: Libraries and tools built with FastCRUD +- 馃摑 **Tutorials**: Learn how to build with FastCRUD + +

Featured Projects

+ +- **[FastAPI Boilerplate](https://github.com/igorbenav/FastAPI-boilerplate)**: Extendable async API using FastAPI, Pydantic V2, SQLAlchemy 2.0 and PostgreSQL +- **[Email Assistant API](https://github.com/igorbenav/email-assistant-api)**: Personalized email writing assistant using OpenAI +- **[SQLModel Boilerplate](https://github.com/igorbenav/SQLModel-boilerplate)**: Async API boilerplate using FastAPI, SQLModel and PostgreSQL + +

Share Your Project

+ +Built something with FastCRUD? We'd love to feature it! Submit your project through our [showcase submission process](https://igorbenav.github.io/fastcrud/community/showcase_submission/). + ## References - This project was heavily inspired by CRUDBase in [`FastAPI Microservices`](https://github.com/Kludex/fastapi-microservices) by [@kludex](https://github.com/kludex). diff --git a/docs/community/showcase_submission.md b/docs/community/showcase_submission.md new file mode 100644 index 0000000..54b694b --- /dev/null +++ b/docs/community/showcase_submission.md @@ -0,0 +1,47 @@ +# Submit Your Project + +!!! tip "Share Your Work" + Have you built something with FastCRUD? We'd love to feature it in our showcase! + +## Project Categories + +!!! example "What You Can Submit" + - **Tutorials**: Step-by-step guides teaching others how to build with FastCRUD + - **Open Source Projects**: Libraries, tools, or applications others can use and learn from + - **Applications**: Web apps, desktop tools, or services built with FastCRUD + - **Commercial Services**: Products or services powered by FastCRUD + +## How to Submit + +!!! info "Submission Steps" + 1. Create a new issue using our [Showcase Submission Template](https://github.com/igorbenav/fastcrud/issues/new?assignees=&labels=showcase&projects=&template=showcase-submission.md&title=Showcase%3A+) + 2. Fill in the relevant information for your project type + 3. We'll review your submission and add it to the showcase! + +## Requirements by Category + +!!! success "What We Look For" + **For Tutorials:** + + - Clear step-by-step instructions + - Working code examples + - Explanation of concepts used + + **For Open Source Projects:** + + - Public repository + - Basic documentation + - Installation/usage instructions + + **For Applications/Services:** + + - Public demo or screenshots + - Description of FastCRUD features used + - Link to live service (if applicable) + +## Need Help? + +!!! question "Questions?" + Need help with your submission? We're here to help! + + - Open a discussion on [GitHub](https://github.com/igorbenav/fastcrud/discussions) \ No newline at end of file diff --git a/docs/showcase.md b/docs/showcase.md new file mode 100644 index 0000000..43f5b9a --- /dev/null +++ b/docs/showcase.md @@ -0,0 +1,53 @@ +# Showcase + +!!! example "**Categories**" + Browse by type: [Applications](#applications) 路 [Tutorials](#tutorials) + +## Applications + +!!! tip "Be the First!" + No applications yet. Have you built something with FastCRUD? We'd love to feature it here! + + **[Submit Your Project](community/showcase_submission.md)** + +## Open Source + +!!! success "FastAPI Boilerplate" + + **By FastCRUD Team** 路 [Source](https://github.com/igorbenav/FastAPI-boilerplate) + + FastAPI boilerplate creates an extendable async API using FastAPI, Pydantic V2, SQLAlchemy 2.0 and PostgreSQL. + + `Template` `FastAPI` `Boilerplate` + +!!! success "Email Assistant API" + + **By FastCRUD Team** 路 [Source](https://github.com/igorbenav/email-assistant-api) + + A personalized email writing assistant built with FastAPI, OpenAI's API, and FastCRUD. + + `OpenAI` `LLM` `AI` + +!!! success "SQLModel Boilerplate" + + **By FastCRUD Team** 路 [Source](https://github.com/igorbenav/SQLModel-boilerplate) + + SQLModel boilerplate creates an extendable async API using FastAPI, SQLModel and PostgreSQL. + + `Template` `SQLModel` `Boilerplate` + +## Tutorials + +!!! note "Creating LLM Powered APIs with FastAPI" + **By FastCRUD Team** 路 [View Tutorial](https://medium.com/@igorbenav/creating-llm-powered-apis-with-fastapi-in-2024-aecb02e40b8f) + + Learn the basics of creating LLM powered APIs with FastCRUD. + + `FastAPI` `AI` `Beginner` `LLM` + +--- + +!!! question "Add Your Project" + Built something with FastCRUD? We'd love to showcase it! + + **[Submit Your Project](community/showcase_submission.md)** \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 06abe3d..3bf8167 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -61,9 +61,11 @@ nav: - EndpointCreator: api/endpoint_creator.md - crud_router: api/crud_router.md - paginated: api/paginated.md + - Showcase: showcase.md - Community: - Overview: community/overview.md - Contributing: community/CONTRIBUTING.md + - Showcase Submission: community/showcase_submission.md - Code of Conduct: community/CODE_OF_CONDUCT.md - License: community/LICENSE.md - Changelog: changelog.md From 89d636bbbf01268ae3b6b406169848e402bb2039 Mon Sep 17 00:00:00 2001 From: Igor Benav Date: Wed, 8 Jan 2025 23:38:49 -0300 Subject: [PATCH 2/2] readme fix --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index a0273bf..f899d2c 100644 --- a/README.md +++ b/README.md @@ -215,6 +215,7 @@ In this example, we define custom endpoints for creating and reading items using To read more detailed descriptions, go to the documentation.

Showcase

+ Browse our [showcase](https://igorbenav.github.io/fastcrud/showcase/) to see projects and tutorials built with FastCRUD: - 馃殌 **Applications**: Web apps and services powered by FastCRUD