https://github.com/hideoo/astro-db-starlight-showcase

A Starlight showcase page using Astro DB
https://github.com/hideoo/astro-db-starlight-showcase

astro astro-db documentation showcase starlight

Last synced: 3 days ago
JSON representation

A Starlight showcase page using Astro DB

• Host: GitHub
• URL: https://github.com/hideoo/astro-db-starlight-showcase
• Owner: HiDeoo
• Created: 2024-03-17T08:54:56.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-18T13:30:42.000Z (11 months ago)
• Last Synced: 2024-12-17T23:07:55.655Z (about 2 months ago)
• Topics: astro, astro-db, documentation, showcase, starlight
• Language: Astro
• Homepage:
• Size: 216 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


  
astro-db-starlight-showcase 🚧

  
A Starlight showcase page using Astro DB.



> [!NOTE]  

> This repository is shared for demonstration purposes only, written in a limited amount of time, and is not intended to be used as a production-ready application.

>

> The goal is to demonstrate how one might use Astro DB in a Starlight application, handle form and image validation, and interface with other services such as GitHub and Cloudflare R2.

## Features

This repository contains a basic example of a showcase related set of custom pages in a Starlight application using Astro DB.

Users can login using their GitHub account and submit their own showcase entry which must include a name, a URL, and an image at specific dimensions.

Users with the `admin` permission can approve or reject entries.

Approved entries are displayed on the showcase page for everyone to see.

- GitHub authentication powered by [Lucia](https://lucia-auth.com/)

- Image hosted on [Cloudflare R2](https://www.cloudflare.com/developer-platform/r2/)

## How to run

1. The application requires various environment variables to be set. Duplicate the `.env.example` file and rename it to `.env.development.local`. Then, fill in the required values (the example file contains links to the documentation for each service).

1. Install the dependencies using `pnpm install`.

1. Run the application using `pnpm dev`.

## License

Licensed under the MIT License, Copyright © HiDeoo.

See [LICENSE](https://github.com/HiDeoo/astro-db-starlight-showcase/blob/main/LICENSE) for more information.