chore: add READMEs for clarity

This commit is contained in:
2025-07-25 02:01:50 +00:00
parent 26dd45ae95
commit 6476333846
5 changed files with 245 additions and 124 deletions

View File

@@ -1,46 +1,96 @@
# Getting Started with Create React App
# minxa.lol Frontend
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
This is the **React-based frontend** for [minxa.lol](https://minxa.lol), a modern and lightweight URL shortener.
## Available Scripts
---
In the project directory, you can run:
## 🧰 Tech Stack
### `npm start`
* **React** Frontend UI framework
* **TypeScript** Typed JavaScript
* **Create React App** App bootstrap and tooling
* **Tailwind CSS** Utility-first styling
* **Redux Toolkit** State management
Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
---
The page will reload if you make edits.\
You will also see any lint errors in the console.
## ⚙️ Environment Setup
### `npm test`
### 1. Install Dependencies
Launches the test runner in the interactive watch mode.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
```bash
npm install
```
### `npm run build`
### 2. Create `.env` File
Builds the app for production to the `build` folder.\
It correctly bundles React in production mode and optimizes the build for the best performance.
```bash
cp .env.example .env
```
The build is minified and the filenames include the hashes.\
Your app is ready to be deployed!
Edit the `.env` file to configure the API URL:
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
```env
REACT_APP_API_BASE_URL=http://localhost:8000
```
### `npm run eject`
---
**Note: this is a one-way operation. Once you `eject`, you cant go back!**
## 🚀 Running the Frontend
If you arent 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.
### Development Server
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 youre on your own.
```bash
npm start
```
You dont have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldnt feel obligated to use this feature. However we understand that this tool wouldnt be useful if you couldnt customize it when you are ready for it.
This starts the development server on [http://localhost:3000](http://localhost:3000).
## Learn More
### Production Build
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
```bash
npm run build
```
To learn React, check out the [React documentation](https://reactjs.org/).
### Test
```bash
npm test
```
### Docker (via Docker Compose)
From the root of the project:
```bash
python generate_configs.py
docker compose -f docker-compose.generated.yml up --build -d
```
---
## 📁 Directory Overview
```
frontend/
├── public/ # Static assets
├── src/
│ ├── api/ # API functions
│ ├── app/ # Redux store and hooks
│ ├── features/ # Feature slices
│ ├── pages/ # Page components
│ ├── routes/ # App router
│ └── utils/ # Client-side utilities
├── .env.example # Sample environment file
├── package.json # Project config and scripts
├── tailwind.config.js
├── tsconfig.json
└── README.md
```
---
## 🧪 Testing (Coming Soon)
Testing will be supported via **React Testing Library** and **Jest**.