Files
astroplate/readme.md
T

132 lines
3.7 KiB
Markdown
Raw Normal View History

2023-05-02 13:12:36 +06:00
<h1 align=center>Astro + Tailwind CSS + TypeScript Starter and Boilerplate</h1>
2023-04-17 16:25:54 +06:00
<p align=center>Astroplate is a free starter template built with Astro, TailwindCSS & TypeScript, providing everything you need to jumpstart your Astro project and save valuable time.</p>
2023-04-17 12:50:29 +06:00
2023-07-16 09:11:29 +06:00
<p align=center>Made with ♥ by <a href="https://zeon.studio/">Zeon Studio</a></p>
2023-04-17 16:25:54 +06:00
2023-07-22 17:02:20 +06:00
<p align=center> If you find this project useful, please give it a ⭐ to show your support. </p>
2025-01-09 12:25:08 +06:00
<h2 align="center"> <a target="_blank" href="https://astroplate.netlify.app/" rel="nofollow">👀 Demo</a> | <a target="_blank" href="https://astroplate-multilang.netlify.app/" rel="nofollow">👀 Demo Multilang</a> | <a target="_blank" href="https://pagespeed.web.dev/analysis/https-astroplate-netlify-app/yzx3foum3w?form_factor=desktop">Page Speed (100%)🚀</a>
2023-04-17 16:25:54 +06:00
</h2>
<p align=center>
2024-02-04 15:35:38 +06:00
<a href="https://github.com/withastro/astro/releases/tag/astro%404.3.2" alt="Contributors">
<img src="https://img.shields.io/static/v1?label=ASTRO&message=4.3&color=000&logo=astro" />
2023-04-17 16:25:54 +06:00
</a>
<a href="https://github.com/zeon-studio/astroplate/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/zeon-studio/astroplate" alt="license"></a>
<img src="https://img.shields.io/github/languages/code-size/zeon-studio/astroplate" alt="code size">
<a href="https://github.com/zeon-studio/astroplate/graphs/contributors">
<img src="https://img.shields.io/github/contributors/zeon-studio/astroplate" alt="contributors"></a>
</p>
2023-05-10 11:18:53 +06:00
## 📌 Key Features
2023-05-02 13:12:36 +06:00
- 👥 Multi-Authors
2024-07-31 12:17:20 +06:00
- 🌐 Multilingual
2023-05-02 13:12:36 +06:00
- 🎯 Similar Posts Suggestion
- 🔍 Search Functionality
- 🌑 Dark Mode
- 🏷️ Tags & Categories
- 🔗 Netlify setting pre-configured
- 📞 Support contact form
- 📱 Fully responsive
- 📝 Write and update content in Markdown / MDX
- 💬 Disqus Comment
- 🔳 Syntax Highlighting
2023-05-10 11:18:53 +06:00
### 📄 15+ Pre-designed Pages
2023-05-02 13:12:36 +06:00
- 🏠 Homepage
- 👤 About
- 📞 Contact
- 👥 Authors
- 👤 Author Single
- 📝 Blog
- 📝 Blog Single
- 🚫 Custom 404
- 💡 Elements
- 📄 Privacy Policy
- 🏷️ Tags
- 🏷️ Tag Single
- 🗂️ Categories
- 🗂️ Category Single
- 🔍 Search
## 🔗 Integrations
2023-04-17 16:25:54 +06:00
2023-05-10 11:18:53 +06:00
- astro/react
2023-04-17 16:25:54 +06:00
- astro/sitemap
2023-05-10 11:18:53 +06:00
- astro/tailwind
2023-04-17 16:25:54 +06:00
2023-05-02 13:12:36 +06:00
## 🚀 Getting Started
2023-04-17 16:25:54 +06:00
2023-05-10 11:18:53 +06:00
### 📦 Dependencies
2023-04-17 12:50:29 +06:00
2025-01-05 15:55:16 +06:00
- astro v5.1+
2023-12-13 09:53:47 +06:00
- node v20.10+
- npm v10.2+
2024-07-31 12:17:20 +06:00
- tailwind v3.4+
2023-04-17 12:50:29 +06:00
2023-07-16 09:11:29 +06:00
### 👉 Install Dependencies
2023-07-22 11:38:07 +06:00
```bash
2023-07-16 09:11:29 +06:00
npm install
```
2023-05-02 13:12:36 +06:00
### 👉 Development Command
2023-04-17 12:50:29 +06:00
2023-07-22 11:38:07 +06:00
```bash
2023-04-17 12:50:29 +06:00
npm run dev
```
2023-05-02 13:12:36 +06:00
### 👉 Build Command
2023-04-17 12:50:29 +06:00
2023-07-22 11:38:07 +06:00
```bash
2023-04-17 12:50:29 +06:00
npm run build
```
2023-04-17 16:25:54 +06:00
2023-07-22 11:46:07 +06:00
### 👉 Build and Run With Docker
```bash
docker build -t astroplate .
# or
2023-11-24 17:50:30 +11:00
# docker --build-arg INSTALLER=npm build -t astroplate .
# or
2023-11-24 17:50:30 +11:00
# docker --build-arg INSTALLER=pnpm build -t astroplate .
docker run -p 3000:80 astroplate
# or
# docker run --rm -p 3000:80 astroplate
```
To access the shell within the container:
```bash
docker run -it --rm astroplate ash
2023-07-22 11:46:07 +06:00
```
2023-04-17 16:25:54 +06:00
<!-- reporting issue -->
2024-07-31 12:17:20 +06:00
2023-05-02 16:26:05 +06:00
## 🐞 Reporting Issues
2023-04-17 16:25:54 +06:00
We use GitHub Issues as the official bug tracker for this Template. Please Search [existing issues](https://github.com/zeon-studio/astroplate/issues). Its possible someone has already reported the same problem.
If your problem or idea has not been addressed yet, feel free to [open a new issue](https://github.com/zeon-studio/astroplate/issues).
<!-- licence -->
2024-07-31 12:17:20 +06:00
2023-05-02 13:12:36 +06:00
## 📝 License
2023-04-17 16:25:54 +06:00
Copyright (c) 2023 - Present, Designed & Developed by [Zeon Studio](https://zeon.studio/)
**Code License:** Released under the [MIT](https://github.comzeon-studio/astroplate/blob/main/LICENSE) license.
**Image license:** The images are only for demonstration purposes. They have their license, we don't have permission to share those images.
2023-05-02 13:12:36 +06:00
## 💻 Need Custom Development Services?
2023-04-17 16:25:54 +06:00
2023-05-10 11:18:53 +06:00
If you need a custom theme, theme customization, or complete website development services from scratch you can [Hire Us](https://zeon.studio/).