https://github.com/duckymomo20012/react-template
My React template
https://github.com/duckymomo20012/react-template
eslint mantine-v5 prettier react react-hook-form react-router-v6 reactjs redux-toolkit tanstack-query template vite windicss
Last synced: 7 months ago
JSON representation
My React template
- Host: GitHub
- URL: https://github.com/duckymomo20012/react-template
- Owner: DuckyMomo20012
- License: mit
- Created: 2022-01-25T13:07:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-01T01:21:22.000Z (over 1 year ago)
- Last Synced: 2024-05-01T02:32:48.214Z (over 1 year ago)
- Topics: eslint, mantine-v5, prettier, react, react-hook-form, react-router-v6, reactjs, redux-toolkit, tanstack-query, template, vite, windicss
- Language: TypeScript
- Homepage: https://my-react-template.netlify.app/
- Size: 1.33 MB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
- [Screenshots](#camera-screenshots)
- [Tech Stack](#space_invader-tech-stack)
- [Features](#dart-features)
- [Color Reference](#art-color-reference)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Prerequisites](#bangbang-prerequisites)
- [Run Locally](#running-run-locally)
- [Running Tests](#test_tube-running-tests)
- [Deployment](#triangular_flag_on_post-deployment)
- [Usage](#eyes-usage)
- [Roadmap](#compass-roadmap)
- [Contributing](#wave-contributing)
- [Code of Conduct](#scroll-code-of-conduct)
- [FAQ](#grey_question-faq)
- [License](#warning-license)
- [Contact](#handshake-contact)
- [Acknowledgements](#gem-acknowledgements)
## :star2: About the Project
### :camera: Screenshots
### :space_invader: Tech Stack
Client
- Javascript
- React.js
- React Router
- Redux Toolkit
- TanStack Query
- React Hook Form
- TailwindCSS
- Mantine
- ESLint
- Prettier
- Vite
- Vitest
- Playwright
- Iconify
Server
Database
DevOps
### :dart: Features
- Feature 1.
- Feature 2.
- Feature 3.
### :art: Color Reference
| Color | Hex |
| --------------- | ---------------------------------------------------------------- |
| Primary Color |  #222831 |
| Secondary Color |  #393E46 |
| Accent Color |  #00ADB5 |
| Text Color |  #EEEEEE |
### :key: Environment Variables
To run this project, you will need to add the following environment variables to
your `.env` file:
- **App configs:**
`VITE_TEST_VAR`: Description of this environment variable.
E.g:
```
# .env
VITE_TEST_VAR="my secret key"
```
You can also check out the file `.env.example` to see all required environment
variables.
## :toolbox: Getting Started
### :bangbang: Prerequisites
This project uses [pnpm](https://pnpm.io/) as package manager:
```bash
npm install --global pnpm
```
### :running: Run Locally
Clone the project:
```bash
git clone https://github.com/DuckyMomo20012/react-template.git
```
Go to the project directory:
```bash
cd react-template
```
Install dependencies:
```bash
pnpm install
```
Start the server:
```bash
pnpm dev
```
### :test_tube: Running Tests
To run tests, run the following command:
```bash
pnpm test
```
### :triangular_flag_on_post: Deployment
To deploy this project run:
```bash
pnpm deploy
```
## :eyes: Usage
Use this space to tell a little more about your project and how it can be used.
Show additional screenshots, code samples, demos, or links to other resources.
```jsx
// foo.jsx
import Component from 'react-template';
function App() {
return ;
}
```
## :compass: Roadmap
- [x] Todo 1.
- [ ] Todo 2.
## :wave: Contributing
Contributions are always welcome!
### :scroll: Code of Conduct
Please read the [Code of Conduct](https://github.com/DuckyMomo20012/react-template/blob/main/CODE_OF_CONDUCT.md).
## :grey_question: FAQ
- Question 1
- Answer 1.
- Question 2
- Answer 2.
## :warning: License
Distributed under MIT license. See
[LICENSE](https://github.com/DuckyMomo20012/react-template/blob/main/LICENSE)
for more information.
## :handshake: Contact
Duong Vinh - [@duckymomo20012](https://twitter.com/duckymomo20012) -
tienvinh.duong4@gmail.com
Project Link: [https://github.com/DuckyMomo20012/react-template](https://github.com/DuckyMomo20012/react-template).
## :gem: Acknowledgements
Here are useful resources and libraries that we have used in our projects:
- [Awesome Readme Template](https://github.com/Louis3797/awesome-readme-template):
A detailed template to bootstrap your README file quickly.