|
1 | | -# Astro Starter Kit: Minimal |
| 1 | +# 👨💻 Coding With Calvin |
2 | 2 |
|
3 | | -```sh |
4 | | -npm create astro@latest -- --template minimal |
5 | | -``` |
| 3 | +Personal blog of Calvin Allen — software development thoughts, tutorials, and experiences. |
6 | 4 |
|
7 | | -> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! |
| 5 | +🌐 **Live at:** [codingwithcalvin.net](https://www.codingwithcalvin.net) |
8 | 6 |
|
9 | | -## 🚀 Project Structure |
| 7 | +## ✨ Features |
10 | 8 |
|
11 | | -Inside of your Astro project, you'll see the following folders and files: |
| 9 | +- 📝 Markdown-based blog posts with frontmatter |
| 10 | +- 🏷️ Category tagging and filtering |
| 11 | +- 📰 RSS feed for subscribers |
| 12 | +- 🎨 Dark theme with custom styling |
| 13 | +- 📱 Fully responsive design |
| 14 | +- ⚡ Lightning-fast static site generation |
| 15 | +- ☁️ Deployed on Cloudflare Pages |
12 | 16 |
|
13 | | -```text |
14 | | -/ |
15 | | -├── public/ |
16 | | -├── src/ |
17 | | -│ └── pages/ |
18 | | -│ └── index.astro |
19 | | -└── package.json |
20 | | -``` |
| 17 | +## 🛠️ Tech Stack |
| 18 | + |
| 19 | +- [Astro](https://astro.build) - Static site generator |
| 20 | +- [Tailwind CSS](https://tailwindcss.com) - Styling |
| 21 | +- [TypeScript](https://typescriptlang.org) - Type safety |
21 | 22 |
|
22 | | -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. |
| 23 | +## 🚀 Quick Start |
23 | 24 |
|
24 | | -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. |
| 25 | +```bash |
| 26 | +# Install dependencies |
| 27 | +npm install |
25 | 28 |
|
26 | | -Any static assets, like images, can be placed in the `public/` directory. |
| 29 | +# Start dev server |
| 30 | +npm run dev |
27 | 31 |
|
28 | | -## 🧞 Commands |
| 32 | +# Build for production |
| 33 | +npm run build |
29 | 34 |
|
30 | | -All commands are run from the root of the project, from a terminal: |
| 35 | +# Preview production build |
| 36 | +npm run preview |
| 37 | +``` |
| 38 | + |
| 39 | +## 📄 Creating a New Post |
31 | 40 |
|
32 | | -| Command | Action | |
33 | | -| :------------------------ | :----------------------------------------------- | |
34 | | -| `npm install` | Installs dependencies | |
35 | | -| `npm run dev` | Starts local dev server at `localhost:4321` | |
36 | | -| `npm run build` | Build your production site to `./dist/` | |
37 | | -| `npm run preview` | Preview your build locally, before deploying | |
38 | | -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | |
39 | | -| `npm run astro -- --help` | Get help using the Astro CLI | |
| 41 | +```bash |
| 42 | +npm run new-post "Your Post Title Here" |
| 43 | +``` |
| 44 | + |
| 45 | +This creates a new markdown file in `src/content/blog/` with the current date and frontmatter template. |
| 46 | + |
| 47 | +## 📁 Project Structure |
| 48 | + |
| 49 | +``` |
| 50 | +src/ |
| 51 | +├── components/ # Reusable Astro components |
| 52 | +├── content/blog/ # Markdown blog posts |
| 53 | +├── layouts/ # Page layouts |
| 54 | +├── pages/ # Routes and pages |
| 55 | +└── styles/ # Global styles |
| 56 | +``` |
40 | 57 |
|
41 | | -## 👀 Want to learn more? |
| 58 | +## 📜 License |
42 | 59 |
|
43 | | -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |
| 60 | +Content © Calvin Allen. Code is MIT licensed. |
0 commit comments