aplp/aplp.frontend.web
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial

Browse Source
This commit is contained in:
namdh
2026-08-11 21:09:32 +07:00
parent e63c8f61aa
commit 94c0c47fd0
44 changed files with 5215 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+61 -71
View File
@@ -1,93 +1,83 @@
# aplp.frontend.reactjs
# aplp.frontend.react
Frontend (React) cho **APLP — Adaptive Personal Learning Platform** (learner application `aplp-web`).
React 19 + TypeScript + Vite · Client mỏng (thin client) gọi API của backend `aplp.backend.spring`. Frontend **không** chứa business rules; mọi quyết định domain (mastery, progress, adaptive) đến từ backend.
## Getting started
## Stack
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
| Lĩnh vực | Công nghệ |
| --- | --- |
| Framework | React 19 |
| Language | TypeScript |
| Build | Vite 8 |
| Routing | React Router 7 |
| HTTP client | Axios (wrapper tại `src/api`) |
| Server-state | TanStack Query |
| Client-state | Zustand |
| Styling | Tailwind CSS 4 |
| Lint | oxlint |
| Format | Prettier |
| Test | Vitest + Testing Library |
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Quick Start
## Add your files
Prerequisite: Node.js 18+ (LTS khuyến nghị).
* [Create](https://docs.gitlab.com/user/project/repository/web_editor/#create-a-file) or [upload](https://docs.gitlab.com/user/project/repository/web_editor/#upload-a-file) files
* [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
```
cd existing_repo
git remote add origin https://gitlab.com/aplp/aplp.frontend.reactjs.git
git branch -M main
git push -uf origin main
```bash
npm install
cp .env.example .env # chỉnh VITE_API_BASE_URL nếu cần
npm run dev # mở địa chỉ Vite (mặc định http://localhost:5173)
```
## Integrate with your tools
Backend chạy local để API hoạt động (xem `docs/SETUP.md`).
* [Set up project integrations](https://gitlab.com/aplp/aplp.frontend.reactjs/-/settings/integrations)
## Scripts
## Collaborate with your team
| Lệnh | Mô tả |
| --- | --- |
| `npm run dev` | Dev server (Vite) |
| `npm run build` | Typecheck + production build |
| `npm run preview` | Preview production build |
| `npm run lint` | Lint (oxlint) |
| `npm run format` / `format:check` | Format bằng Prettier |
| `npm run typecheck` | Typecheck (tsc) |
| `npm test` / `test:watch` | Unit test (Vitest) |
* [Invite team members and collaborators](https://docs.gitlab.com/user/project/members/)
* [Create a new merge request](https://docs.gitlab.com/user/project/merge_requests/creating_merge_requests/)
* [Automatically close issues from merge requests](https://docs.gitlab.com/user/project/issues/managing_issues/#closing-issues-automatically)
* [Enable merge request approvals](https://docs.gitlab.com/user/project/merge_requests/approvals/)
* [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
## Structure
## Test and Deploy
```text
src/
├── app/ # app entry, router, providers, layout, pages
├── api/ # api client (axios), token storage
├── features/ # feature modules (auth, learner, course, ...)
│ └── auth/ # api, components, hooks, pages, store
├── shared/ # shared components, hooks, config
└── types/ # shared types / DTO contracts
```
Use the built-in continuous integration in GitLab.
Chi tiết: [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md), [docs/CONVENTIONS.md](./docs/CONVENTIONS.md).
* [Get started with GitLab CI/CD](https://docs.gitlab.com/ci/quick_start/)
* [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/user/application_security/sast/)
* [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/topics/autodevops/requirements/)
* [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/user/clusters/agent/)
* [Set up protected environments](https://docs.gitlab.com/ci/environments/protected_environments/)
## Auth Flow
***
- Access token lưu **in-memory** (`src/api/tokenStorage.ts`), không persist vào storage trình duyệt.
- Refresh token do backend quản lý (HttpOnly cookie); client không chạm tới.
- `401` → api client tự gọi `/auth/refresh` rồi retry request gốc (không loop trên endpoint auth).
- Route bảo vệ qua `ProtectedRoute` (redirect `/login` nếu chưa đăng nhập).
# Editing this README
Chi tiết: [docs/PHASES.md](./docs/PHASES.md) (Phase 0).
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Documents
## Suggestions for a good README
| Tài liệu | Mô tả |
| --- | --- |
| [docs/PHASES.md](./docs/PHASES.md) | Công việc frontend theo từng phase APLP |
| [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md) | Kiến trúc: folder structure, data flow, auth |
| [docs/CONVENTIONS.md](./docs/CONVENTIONS.md) | Coding conventions |
| [docs/SETUP.md](./docs/SETUP.md) | Setup / khởi tạo dự án |
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
Backend: [aplp.backend.spring](../aplp.backend.spring) — kế hoạch phase tổng thể: [APLP-Project-Phases.md](../aplp.backend.spring/APLP-Project-Phases.md).
## Name
Choose a self-explaining name for your project.
## Status
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
Phase 0 (Foundation) — hoàn tất. Xem danh sách completion criteria tại [docs/PHASES.md](./docs/PHASES.md).