Merge pull request #193 from igorbenav/showcase

Showcase page

.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

README.md

@@ -214,6 +214,24 @@ In this example, we define custom endpoints for creating and reading items using
 
 To read more detailed descriptions, go to the <a href="https://igorbenav.github.io/fastcrud/">documentation</a>.
 
+<h2>Showcase</h2>
+
+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
+
+<h3>Featured Projects</h3>
+
+- **[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
+
+<h3>Share Your Project</h3>
+
+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).

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)

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)**

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