An open API service indexing awesome lists of open source software.

https://github.com/xkeshav/astro-template

Astro Boiler plate
https://github.com/xkeshav/astro-template

astrojs

Last synced: 2 months ago
JSON representation

Astro Boiler plate

Awesome Lists containing this project

README

        

# Template to Start Astro + React

This is a codebase for to Start Project in Astro + React .

## The template contain

- Shadcn for component
- tailwind for styling
- Zustand for state management
- TypeScript for type safety
- Zod for form type safe form validation

### How To Start

### pre-requisite

- Node v 18 or higher
- open vscode and open startup.vscode-workspace file

## 🚀 Project Structure

Inside of your Astro project, you'll see the following folders and files:

```text
.
├── astro.config.mjs
├── astro-i18next.config.mjs
├── CHANGELOG.MD
├── components.json
├── docs
│   ├── README.md
│   └── state-management.md
├── jsconfig.json
├── LICENSE
├── package.json
├── package-lock.json
├── postcss.config.js
├── public
│   ├── 192x192.png
│   ├── 512x512.png
│   ├── android-chrome-192x192.png
│   ├── android-chrome-512x512.png
│   ├── apple-touch-icon.png
│   ├── favicon.svg
│   ├── logo-white.svg
│   ├── manifest.webmanifest
│   ├── profile-placeholder.jpg
│   ├── robots.txt
│   ├── sitemap-index.html
├── README.md
├── src
│   ├── assets
│   ├── components
│   ├── content
│   ├── env.d.ts
│   ├── hooks
│   ├── icons
│   ├── layouts
│   ├── libs
│   ├── locales
│   ├── mocks
│   ├── models
│   ├── pages
│   ├── postcss.config.cjs
│   ├── site.config.ts
│   ├── types.ts
│   └── utils
├── tailwind.config.ts
├── todo.md
├── tsconfig.eslint.json
├── tsconfig.json
└── tz-client.code-workspace
```

and src

## Installation

```bash
npm install
```

### Development

To start the development server, run:

```bash
npm run dev
```

The server will start on `http://localhost:4321`.

### Deployment

run in local

```sh
npm run lint
npm run build
```

and then check with

```sh
npm run preview
```