docs: Update README for Astro project
This commit is contained in:
77
README.md
77
README.md
@@ -1,43 +1,62 @@
|
||||
# Astro Starter Kit: Minimal
|
||||
# Deal Plus Tech - Astro Website
|
||||
|
||||
```sh
|
||||
npm create astro@latest -- --template minimal
|
||||
**Astro** static site for Deal Plus Tech - Thai pipe & HVAC materials supplier.
|
||||
|
||||
## 🚀 Quick Start
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Development
|
||||
npm run dev
|
||||
|
||||
# Build for production
|
||||
npm run build
|
||||
|
||||
# Preview production build
|
||||
npm run preview
|
||||
```
|
||||
|
||||
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||
## 📁 Project Structure
|
||||
|
||||
## 🚀 Project Structure
|
||||
|
||||
Inside of your Astro project, you'll see the following folders and files:
|
||||
|
||||
```text
|
||||
/
|
||||
├── public/
|
||||
```
|
||||
.
|
||||
├── src/
|
||||
│ └── pages/
|
||||
│ └── index.astro
|
||||
└── package.json
|
||||
│ ├── components/ # Astro components
|
||||
│ ├── layouts/ # Layout components
|
||||
│ ├── pages/ # Astro pages
|
||||
│ ├── content/ # Markdown content
|
||||
│ ├── data/ # Static data
|
||||
│ └── styles/ # Global styles
|
||||
├── public/ # Static assets
|
||||
├── Dockerfile # Production Docker
|
||||
└── package.json # Dependencies
|
||||
```
|
||||
|
||||
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
|
||||
## 🛠️ Tech Stack
|
||||
|
||||
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
|
||||
- **Framework:** Astro 5.x
|
||||
- **Styling:** Tailwind CSS 4
|
||||
- **Content:** Astro Content Collections
|
||||
- **Deployment:** Easypanel (Docker)
|
||||
|
||||
Any static assets, like images, can be placed in the `public/` directory.
|
||||
## 🚢 Deployment
|
||||
|
||||
## 🧞 Commands
|
||||
The site deploys automatically to Easypanel via Git:
|
||||
|
||||
All commands are run from the root of the project, from a terminal:
|
||||
1. Push to `main` branch
|
||||
2. Easypanel builds with Dockerfile
|
||||
3. Deploys to: `http://customerwebsite-dealplustech.easypanel.app`
|
||||
|
||||
| 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 |
|
||||
## 📝 Recent Changes
|
||||
|
||||
## 👀 Want to learn more?
|
||||
- ✅ Moved Astro project to root (was in `dealplustech-astro/`)
|
||||
- ✅ Removed Next.js code (archived in `_nextjs-backup/`)
|
||||
- ✅ Fixed product tables responsiveness
|
||||
- ✅ Fixed favicon 404 errors
|
||||
- ✅ Added responsive font scaling
|
||||
|
||||
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
|
||||
## 📞 Support
|
||||
|
||||
For issues or questions, contact the DevOps team.
|
||||
|
||||
Reference in New Issue
Block a user