Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unllamas/react-starter-kit
https://github.com/unllamas/react-starter-kit
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/unllamas/react-starter-kit
- Owner: unllamas
- License: mit
- Created: 2024-08-22T16:11:54.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-08-23T04:20:14.000Z (4 months ago)
- Last Synced: 2024-10-06T02:21:23.448Z (3 months ago)
- Language: TypeScript
- Homepage: https://react-starter-kit-rho.vercel.app/
- Size: 85.9 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# react-starter-kit
[](https://github.com/unllamas/react-starter-kit/blob/main/LICENSE)
## 🤓 Tech Stack
- [React](https://react.dev/) for web app
- [Tailwind](https://tailwindcss.com/) for style
- [Shadcn](https://ui.shadcn.com/) for UI components
## 🚀 Get Started
Prerequisites:
- [Node](https://nodejs.org/)
- [PNPM](https://pnpm.io/)
To set up the app execute the following commands.
```bash
git clone https://github.com/unllamas/react-starter-kit.git
cd ...
```
### Installation
```bash
pnpm install
```
##### `pnpm dev`
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
##### `pnpm build`
Builds the app for production to the `dist` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
See the section about [deployment](https://vitejs.dev/guide/static-deploy) for more information.
## 🗄️ Project Structure
Most of the code lives in the `src` folder and looks something like this:
```sh
src
├── app
│ └── index.(tsx)
│ └── provider.(tsx)
│ └── route.(tsx)
│ └── routes (pages folder)
│ └── home.(tsx)
│ └── not-found.(tsx)
├── components
│ └── ui
│ └── seo
│ └── errors
│ └── theme
├── features
│ └── navbar
│ └── hero
└── lib
└── utils.(tsx)
```