|
1 | 1 |
|
2 | | -# React-TypeScript Testing Library and Tailwind CSS Template |
3 | | - |
4 | | -Unlike Create-React-App, Vite doesnt come by default with Testing Library, Jest setup with it . So, this repository can help you out in quickly getting started. |
5 | | - |
6 | | - |
7 | | -## Features |
8 | | - |
9 | | -- **[React](https://react.dev)**: A popular JavaScript library for building user interfaces. |
10 | | -- **[Typescript](https://www.typescriptlang.org/)**: A typed superset of JavaScript that helps catch errors early and improve code quality. |
11 | | -- **[Jest](https://jestjs.io/)**: A testing utility for writing unit and integration tests with a user-centric approach. |
12 | | -- **[React-Testing-Library](https://testing-library.com/)**: A testing library for React for writing unit and integration tests with a user-centric approach. |
13 | | -- **[Tailwind](https://tailwindcss.com/)**: A utility-first CSS framework for rapidly building custom designs. |
14 | | - |
15 | | -## Getting Started |
16 | | -Follow these steps to set up a new project based on this template: |
17 | | - |
18 | | -1. Click the "Use this template" button on this repository to create a new repository using this template. |
19 | | - |
20 | | -2. Clone your newly created repository to your local machine: |
21 | | - |
22 | | - ```bash |
23 | | - git clone https://github.com/amitjimiwal/React-ts-jest-template.git |
24 | | - ``` |
25 | | - |
26 | | -3. Navigate to the project directory: |
27 | | - |
28 | | - ```bash |
29 | | - cd your-project-name |
30 | | - ``` |
31 | | - |
32 | | -4. Install dependencies: |
33 | | - |
34 | | - ```bash |
35 | | - npm install |
36 | | - ``` |
37 | | - |
38 | | -5. Start the development server: |
39 | | - |
40 | | - ```bash |
41 | | - npm run dev |
42 | | - ``` |
43 | | - |
44 | | -6. Open your browser and visit `http://localhost:5173` to see your app in action. |
45 | | - |
46 | | -## Contributing |
47 | | - |
48 | | -Contributions to improve this template are welcome! If you find any issues or have suggestions for enhancements, feel free to open an issue or submit a pull request. |
49 | | - |
50 | | -1. Fork the repository. |
51 | | - |
52 | | -2. Create a new branch: |
53 | | - |
54 | | - ```bash |
55 | | - git checkout -b feature/your-feature-name |
56 | | - ``` |
57 | | - |
58 | | -3. Make your changes and commit them: |
59 | | - |
60 | | - ```bash |
61 | | - git commit -m "Add your changes" |
62 | | - ``` |
63 | | - |
64 | | -4. Push your changes to your forked repository: |
65 | | - |
66 | | - ```bash |
67 | | - git push origin feature/your-feature-name |
68 | | - ``` |
69 | | - |
70 | | -5. Open a pull request against the `main` branch of this repository. |
71 | | - |
72 | | -## License |
73 | | - |
74 | | -This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |
| 2 | +# TypeSight |
0 commit comments