https://github.com/ayungavis/parcel-react-typescript
Parcel + React boilerplate for your app
https://github.com/ayungavis/parcel-react-typescript
chakra parcel react react-router typescript
Last synced: 5 months ago
JSON representation
Parcel + React boilerplate for your app
- Host: GitHub
- URL: https://github.com/ayungavis/parcel-react-typescript
- Owner: ayungavis
- License: mit
- Created: 2023-01-31T05:59:58.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T09:32:39.000Z (over 2 years ago)
- Last Synced: 2024-01-05T10:45:59.544Z (over 2 years ago)
- Topics: chakra, parcel, react, react-router, typescript
- Language: TypeScript
- Homepage: https://parcel-react-typescript.pages.dev/
- Size: 2.67 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Parcel + React Boilerplate 🚀
This is a boilerplate for React + Typescript + Parcel. It's a simple boilerplate that I use for my personal projects. It's not a complete boilerplate, but it's a good starting point for your project.
The project is also hosted on [CloudFlare page](https://parcel-react-typescript.pages.dev/).
## Table of Contents
- [Parcel + React Boilerplate 🚀](#parcel--react-boilerplate-)
- [Table of Contents](#table-of-contents)
- [Getting Started](#getting-started)
- [Tools Required](#tools-required)
- [Running the App](#running-the-app)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [Versioning](#versioning)
- [Authors](#authors)
- [Wahyu Kurniawan](#wahyu-kurniawan)
- [License](#license)
## Getting Started
Other details that need to be given while starting out with the project can be provided in this section. A project structure like below can also be included for the big projects:
```
parce-react-typescript
├── README.md
├── package.json
├── tsconfig.json
├── .gitignore
├── .parcelrc
├── .nvmrc
├── public
│ └── README.md
└── src
├── App.tsx
├── index.tsx
├── index.html
└── router.tsx
```
### Tools Required
All tools required go here. You would require the following tools to develop and run the project:
- A text editor or an IDE (like VSCode)
- Node.js => `v16.0.0`
- Yarn => `v1.22.10`
### Running the App
All installation steps go here.
- Clone the repository
```bash
git clone https://github.com/ayungavis/parcel-react-typescript
```
- Install dependencies
```bash
yarn install
```
- Run the app
```bash
yarn dev
```
- Build the app
```bash
yarn build
```
## Deployment
This section is completely optional. Add additional notes about how to deploy this on a live system
## Contributing
Mention what you expect from the people who want to contribute
We'd love to have your helping hand on `Parcel + React Boilerplate`! See [CONTRIBUTING.md](https://github.com/ayungavis/parcel-react-typescript/blob/main/CONTRIBUTING.md) for more information on what we're looking for and how to get started.
## Versioning
If your project has multiple versions, include information about it here.
For the available versions, see the [tags on this repository](https://github.com/ayungavis/parcel-react-typescript/tags)
## Authors
#### Wahyu Kurniawan
- [GitHub](https://github.com/ayungavis)
- [LinkedIn](https://linkedin.com/in/ayungavis)
You can also see the complete [list of contributors](https://github.com/ayungavis/parcel-react-typescript/graphs/contributors) who participated in this project.
## License
`Parcel + React Boilerplate` is open source software [licensed as MIT](https://github.com/ayungavis/parcel-react-typescript/blob/main/LICENSE).