Files
astroplate/readme.md
T
2024-02-04 15:35:38 +06:00

129 lines
3.6 KiB
Markdown
Executable File
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<h1 align=center>Astro + Tailwind CSS + TypeScript Starter and Boilerplate</h1>
<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>
<p align=center>Made with ♥ by <a href="https://zeon.studio/">Zeon Studio</a></p>
<p align=center> If you find this project useful, please give it a ⭐ to show your support. </p>
<h2 align="center"> <a target="_blank" href="https://astroplate.netlify.app/" rel="nofollow">👀 Demo</a> | <a target="_blank" href="https://pagespeed.web.dev/analysis/https-astroplate-netlify-app/yzx3foum3w?form_factor=desktop">Page Speed (100%)🚀</a>
</h2>
<p align=center>
<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" />
</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>
## 📌 Key Features
- 👥 Multi-Authors
- 🎯 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
### 📄 15+ Pre-designed Pages
- 🏠 Homepage
- 👤 About
- 📞 Contact
- 👥 Authors
- 👤 Author Single
- 📝 Blog
- 📝 Blog Single
- 🚫 Custom 404
- 💡 Elements
- 📄 Privacy Policy
- 🏷️ Tags
- 🏷️ Tag Single
- 🗂️ Categories
- 🗂️ Category Single
- 🔍 Search
## 🔗 Integrations
- astro/react
- astro/sitemap
- astro/tailwind
## 🚀 Getting Started
### 📦 Dependencies
- astro 4.0+
- node v20.10+
- npm v10.2+
- tailwind v3.3+
### 👉 Install Dependencies
```bash
npm install
```
### 👉 Development Command
```bash
npm run dev
```
### 👉 Build Command
```bash
npm run build
```
### 👉 Build and Run With Docker
```bash
docker build -t astroplate .
# or
# docker --build-arg INSTALLER=npm build -t astroplate .
# or
# 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
```
<!-- reporting issue -->
## 🐞 Reporting Issues
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 -->
## 📝 License
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.
## 💻 Need Custom Development Services?
If you need a custom theme, theme customization, or complete website development services from scratch you can [Hire Us](https://zeon.studio/).