From 4866e49955003cb46b03ba652bc628274cd1da48 Mon Sep 17 00:00:00 2001 From: link1226 Date: Tue, 24 Sep 2024 19:41:08 -0400 Subject: [PATCH] Update README.md --- README.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/README.md b/README.md index b977105..38c06b5 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,25 @@ A modern starter based on Astro.js, Tailwind, daisyUI, and [Netlify Core Primitives](https://docs.netlify.com/core/overview/#develop) (Edge Functions, Image CDN, Blob Store). +## Overview +This project integrates Astro.js for static site generation with Tailwind CSS for utility-first styling and daisyUI components to enhance user interface design. It is optimized for deployment on Netlify, utilizing its Edge Functions, Image CDN, and Blob Store capabilities. + +## Use Cases: +Building a modern, responsive, and performant website. +Quickly deploying static sites or Jamstack apps with advanced Netlify features. +Tailoring web applications using Astro's powerful component system. + +## Project Structure: + +astro-platform-starter/ +├── public/ # Static files (images, etc.) +├── src/ +│ ├── components/ # Reusable UI components +│ ├── layouts/ # Layout templates for pages +│ └── pages/ # Pages in the project +├── netlify/ # Netlify-specific configurations +└── package.json # Project dependencies and scripts + ## Astro Commands All commands are run from the root of the project, from a terminal: @@ -30,6 +49,10 @@ All commands are run from the root of the project, from a terminal: 1. Clone this repository, then run `npm install` in its root directory. +``` +git clone https://github.com/YOUR_USERNAME/astro-platform-starter.git +``` + 2. For the starter to have full functionality locally (e.g. edge functions, blob store), please ensure you have an up-to-date version of Netlify CLI. Run: ``` @@ -49,3 +72,22 @@ netlify dev ``` If your browser doesn't navigate to the site automatically, visit [localhost:8888](http://localhost:8888). + +## Customization +Tailwind CSS & daisyUI +You can modify the `tailwind.config.js` file to customize the default theme or add custom components. + +Netlify Functions +For Edge Functions and other Netlify-specific features, refer to the `netlify` directory. You can update the configurations to suit your deployment needs. + +Netlify functions +## Common Issues and Troubleshooting +Local server not starting: Ensure Node.js is installed, and you are using the correct version (v18.14+). You can manage versions with nvm if needed. +Netlify CLI errors: Try re-installing the Netlify CLI if you encounter issues or ensure that your account is properly linked to the project. + +## FAQ +Q: How do I update the Astro.js version? +A: You can update the version by modifying the package.json file and running npm install to refresh the dependencies. + +Q: Can I use another hosting service besides Netlify? +A: Yes, but you'll need to adapt the deployment process accordingly, as this project is optimized for Netlify's platform and features. \ No newline at end of file