Skip to content

Latest commit

 

History

History
101 lines (77 loc) · 2.38 KB

README.md

File metadata and controls

101 lines (77 loc) · 2.38 KB
Raw

Astronomy

An open source application built using the latest features in Astro v3 with shadcn/ui.

blog

Warning This app is a work in progress. I'm building this in public. You can follow the progress on Twitter @miickasmt. See the roadmap below.

About this project

This project as an experiment to see how a modern app (with features like authentication, subscriptions, API routes, Markdown, Content Collections ...etc) would work in Astro 3.0 and shadcn/ui.

Note I would like to inform you that for the time being, my example app built with Astro.js is still under development and cannot yet be considered a starter template.

Project Structure

├── public/
│   └── fonts/
├── src/
│   ├── components/
│   ├── config/
│   ├── content/
│   ├── hooks/
│   ├── icons/
│   ├── layouts/
│   ├── lib/
│   ├── pages/
│   ├── styles/
│   └── types/
├── astro.config.mjs
├── README.md
├── package.json
├── tailwind.config.cjs
└── tsconfig.json

Features

  • Config files
  • Views Transitions
  • Routing and Layouts
  • React components & hooks
  • UI Components built using shadcn/ui
  • Documentation and blog using MDX and Content Collections
  • Styled using Tailwind CSS
  • Validations using Zod
  • Written in TypeScript
  • 100/100 Lighthouse performance
  • Minimal styling (make it your own!)

Not implemented yet :

  • RSS Feed support
  • Sitemap support
  • Data Fetching
  • SEO component
  • API Routes and Middlewares
  • Authentication using Auth.js
  • ORM using Prisma
  • Database on PlanetScale
  • Subscriptions using Stripe

Roadmap

  • Dark mode
  • Add Markdown & MDX support
  • Sheet mobile nav
  • Dropdown mobile nav
  • Build auth pages
  • Build dashboard pages
  • Add search support for blog
  • Add OG image for blog and others
  • Add SEO component & metadata
  • Subscriptions using Stripe

Running Locally

  1. Install dependencies using pnpm:
pnpm install
  1. Start the development server:
pnpm run dev

Credit

This theme is based off of the example app Taxonomy of shadcn.

License

Licensed under the MIT license.