https://github.com/emasuriano/astro-mate

New version of Gatsby Mate, built in Astro
https://github.com/emasuriano/astro-mate

astro portfolio react tailwindcss

Last synced: 3 months ago
JSON representation

New version of Gatsby Mate, built in Astro

• Host: GitHub
• URL: https://github.com/emasuriano/astro-mate
• Owner: EmaSuriano
• License: mit
• Created: 2022-07-18T07:41:30.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-11-01T08:05:02.000Z (3 months ago)
• Last Synced: 2024-11-01T08:28:33.384Z (3 months ago)
• Topics: astro, portfolio, react, tailwindcss
• Language: Astro
• Homepage: https://astro-mate.netlify.app
• Size: 1.89 MB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Astro Theme: Mate 🧉

[![Build](https://github.com/EmaSuriano/astro-mate/actions/workflows/master.yml/badge.svg?branch=master)](https://github.com/EmaSuriano/astro-mate/actions/workflows/master.yml)

[![Netlify Status](https://api.netlify.com/api/v1/badges/048d0e6b-f5c6-437d-bdca-2fd7adf66a7a/deploy-status)](https://app.netlify.com/sites/astro-mate/deploys)

> An accessible and fast portfolio starter for Astro, for Developers and Tech Writers.

## [✨ Demo](https://astro-mate.netlify.app/)

## Project Overview 👨‍💻

- [Astro](https://astro.build/) with Typescript support

- Icons from [Iconify](https://iconify.design/)

- [Daisy UI](https://daisyui.com/) as the component library (powered by [Tailwind](https://tailwindcss.com/))

- [Github Gist](https://gist.github.com/) as CMS for simplicity and transparency

- [DevTo](https://dev.to/) API Integration

- Schema validation with [Zod](https://github.com/colinhacks/zod) and automatic schema generation [ts-to-zod](https://github.com/fabien0102/ts-to-zod)

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

## 🚀 Project Structure

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

```

/

├── public/

│   └── favicon.ico

├── src/

│   ├── components/

│   │   └── Layout.astro

│   └── pages/

│       └── index.astro

└── package.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 or layouts.

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                                       |

| :------------- | :------------------------------------------- |

| `yarn`         | Installs dependencies                        |

| `yarn dev`     | Starts local dev server at `localhost:3000`  |

| `yarn build`   | Build your production site to `./dist/`      |

| `yarn preview` | Preview your build locally, before deploying |

## 👀 Want to learn more?

Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).