diff --git a/README.md b/README.md index bb15685..0a6974c 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,21 @@ -# React + TypeScript + Vite +# Check this Frontend out! 👀 +> Check Out! You can get your personalized outfit from our AI stylist 🌊 -This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules. +![Service main page UI](https://github.com/Hot-Spicy-Buffalo-Wing/check-out-fe/assets/42310616/1f07584a-754e-45bd-87a0-b457bd330185) -Currently, two official plugins are available: +--- -- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh -- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh +### 1. Frontend Development Initialization +- install dependencies with `yarn` +- run the code with `yarn dev` -## Expanding the ESLint configuration +### 2. Frontend Tech Stack +- Vite + React + Typescript +- Adopted [Mantine](https://mantine.dev/) UI system -If you are developing a production application, we recommend updating the configuration to enable type aware lint rules: - -- Configure the top-level `parserOptions` property like this: - -```js -export default { - // other rules... - parserOptions: { - ecmaVersion: "latest", - sourceType: "module", - project: ["./tsconfig.json", "./tsconfig.node.json"], - tsconfigRootDir: __dirname, - }, -}; +### 3. UI Flow +``` +Landing page |- Sign up page + |- Sign in page |- Main page |- Post list page |- Post create page + |- Post detail page ``` - -- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked` -- Optionally add `plugin:@typescript-eslint/stylistic-type-checked` -- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list