|
1 | | -# Getting Started with Create React App |
| 1 | +# Frontend App (Vite + React + TypeScript) |
2 | 2 |
|
3 | | -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). |
| 3 | +This project is built with [Vite](https://vitejs.dev/), React, and TypeScript. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +- Node.js >= 20.0.0 |
| 8 | +- npm |
4 | 9 |
|
5 | 10 | ## Available Scripts |
6 | 11 |
|
7 | 12 | In the project directory, you can run: |
8 | 13 |
|
9 | | -### `npm start` |
| 14 | +### `npm run dev` |
10 | 15 |
|
11 | | -Runs the app in the development mode.\ |
12 | | -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. |
| 16 | +Runs the app in development mode.\ |
| 17 | +Open [http://localhost:5173](http://localhost:5173) to view it in the browser. |
13 | 18 |
|
14 | | -The page will reload if you make edits.\ |
15 | | -You will also see any lint errors in the console. |
| 19 | +The page will hot-reload when you make edits. |
16 | 20 |
|
17 | | -### `npm test` |
| 21 | +### `npm run build` |
18 | 22 |
|
19 | | -Launches the test runner in the interactive watch mode.\ |
20 | | -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. |
| 23 | +Type-checks with TypeScript and builds the app for production to the `dist` folder.\ |
| 24 | +The build is optimized and minified for best performance. |
21 | 25 |
|
22 | | -### `npm run build` |
| 26 | +### `npm run preview` |
| 27 | + |
| 28 | +Serves the production build locally for testing before deployment. |
23 | 29 |
|
24 | | -Builds the app for production to the `build` folder.\ |
25 | | -It correctly bundles React in production mode and optimizes the build for the best performance. |
| 30 | +### `npm test` |
26 | 31 |
|
27 | | -The build is minified and the filenames include the hashes.\ |
28 | | -Your app is ready to be deployed! |
| 32 | +Runs the test suite using [Vitest](https://vitest.dev/). |
29 | 33 |
|
30 | | -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. |
| 34 | +### `npm run test:watch` |
31 | 35 |
|
32 | | -### `npm run eject` |
| 36 | +Launches the test runner in interactive watch mode. |
33 | 37 |
|
34 | | -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** |
| 38 | +## Environment Variables |
35 | 39 |
|
36 | | -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. |
| 40 | +Environment variables are prefixed with `VITE_` and accessed via `import.meta.env`. |
37 | 41 |
|
38 | | -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. |
| 42 | +See `.env` for local development configuration: |
39 | 43 |
|
40 | | -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. |
| 44 | +```env |
| 45 | +VITE_API_BASE_URL=http://127.0.0.1:8000 |
| 46 | +``` |
41 | 47 |
|
42 | 48 | ## Learn More |
43 | 49 |
|
44 | | -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). |
45 | | - |
46 | | -To learn React, check out the [React documentation](https://reactjs.org/). |
| 50 | +- [Vite Documentation](https://vitejs.dev/guide/) |
| 51 | +- [React Documentation](https://react.dev/) |
| 52 | +- [Vitest Documentation](https://vitest.dev/) |
0 commit comments