Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/hvxley/cloudstrap-mastodon

Cloudstrap template meets Astro-mastodon: We now have mastodon mentions!
https://github.com/hvxley/cloudstrap-mastodon

astro astrojs-boilerplate astrojs-template bootstrap5 javascript mastodon sass template theme

Last synced: 3 months ago
JSON representation

Cloudstrap template meets Astro-mastodon: We now have mastodon mentions!

Awesome Lists containing this project

README

        

# Cloudstrap-mastodon Theme for Astro
[![Netlify Status](https://api.netlify.com/api/v1/badges/27f03041-17a9-4279-b612-619185f7b5a8/deploy-status)](https://app.netlify.com/sites/cloudstrap-mastodon/deploys)

```sh
npm create astro@latest -- --template hvxley/cloudstrap-mastodon
```

This free Astro starter template brings Bootstrap, Astro-Icons, and Sass to your project.

Check back again soon!

Features:
* Astro v4.9
* Bootstrap v5.3
* Color mode featuring Light, Dark, and Auto.
* Icon Pack [from astro-icons, iconify, and remix](https://icon-sets.iconify.design/ri/)
* Mobile-first design
* SEO Optimization
* Netlify-ready Contact Form with Recaptcha
* Sitemap
* Mastodon mentions in blog posts

## Project structure

Inside **Cloudstrap-mastodon** template, you'll see the following folders and files:

```
/
├── public/
│ ├── favicons/
│ │ └── favicon.svg
│ ├── bootstrap-logo-white.svg
│ ├── lighthouse.png
│ ├── humans.txt
│ └── robots.txt
├── src/
│ ├── components/
│ │ ├── ColorModeButton.astro
│ │ ├── ColorModeGraphics.astro
│ │ ├── FormattedDate.astro
│ │ ├── Footer.astro
│ │ ├── Meta.astro
│ │ └── Navbar.astro
│ ├── content/
│ │ ├── blog/
| │ │ ├── bootstrap-cheatsheet.md
| │ │ ├── bootstrap-grid.md
| │ │ └── mastodon-mentions.md
│ │ └── config.ts
│ ├── layouts/
│ │ ├── BlogPost.astro
│ │ └── Layout.astro
│ ├── pages/
│ │ ├──blog/
| │ │ ├── [...slug].astro
| │ │ └── index.astro
│ │ ├── about.astro
│ │ ├── index.astro
│ │ └── thankyou.astro
│ ├── scripts/
│ │ ├── bs-initial.js
│ │ └── color-modes.js
│ ├── styles/
│ │ └── stylesheet.scss
│ └── env.d.ts
├── .gitignore
├── astro.config.mjs
├── package.json
├── README.md
├── 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.

Any static assets, like images, can be placed in the `public/` directory if they do not require any transformation or in the `assets/` directory if they are imported directly.

## Commands

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

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

To generate a new Sitemap, update your domain URL in `astro.config.mjs` and run `npm run build`.

## Lighthouse Score
![Lighthouse Score](https://cloudstrap.huxley.cloud/lighthouse.png "Lighthouse Score")