Skip to content

Updated README.md #100

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Updated README.md #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:

```
Expand All @@ -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.