Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/engageintellect/engage-showcase

A personal portfolio & blog using Astro3.0, Svelte, and TailwindCSS
https://github.com/engageintellect/engage-showcase

astro md mdx svelte tailwindcss

Last synced: 5 days ago
JSON representation

A personal portfolio & blog using Astro3.0, Svelte, and TailwindCSS

Awesome Lists containing this project

README

        

# engage-showcase

## Description:

A showcase of personal projects, expiriments, and articles.

## Getting Started:

### Clone the repo

```
git clone https://github.com/engageintellect/engage-showcase.git
```

```
cd engage-showcase
```

### Install dependencies

```
pnpm install
```

### Run the dev server

```
pnpm run dev
```

Features:

- ✅ Minimal styling
- ✅ TailwindCSS
- ✅ TypeScript
- ✅ Svelte components for state
- ✅ 100/100 Lighthouse performance
- ✅ SEO-friendly with canonical URLs and OpenGraph data
- ✅ Sitemap support
- ✅ RSS Feed support
- ✅ Markdown & MDX support

## Project Structure

Inside of your Astro project, you'll see the following folders and files:

```

├── public/
├── src/
│   ├── components/
│   ├── content/
│   ├── layouts/
│   └── pages/
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.json

```

Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.

There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.

The `src/content/` directory contains "collections" of related Markdown and MDX documents. Use `getCollection()` to retrieve posts from `src/content/blog/`, and type-check your frontmatter using an optional schema. See [Astro's Content Collections docs](https://docs.astro.build/en/guides/content-collections/) to learn more.

Any static assets, like images, can be placed in the `public/` directory.

## Commands

All commands are run from the root of the project, from a terminal:

| Command | Action |
| :------------------------- | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm run dev` | Starts local dev server at `localhost:4321` |
| `pnpm run build` | Build your production site to `./dist/` |
| `pnpm run preview` | Preview your build locally, before deploying |
| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm run astro -- --help` | Get help using the Astro CLI |

## Want to learn more?

Check out [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).