Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/se-academic-group/thich-doc-truyen-frontend
Story reading web application - Client side
https://github.com/se-academic-group/thich-doc-truyen-frontend
chinese-novels github-actions hcmus nextjs playwright react rsc software-design tailwindcss vitest
Last synced: 24 days ago
JSON representation
Story reading web application - Client side
- Host: GitHub
- URL: https://github.com/se-academic-group/thich-doc-truyen-frontend
- Owner: SE-Academic-Group
- License: unlicense
- Created: 2024-05-12T14:21:42.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-07-02T08:12:55.000Z (7 months ago)
- Last Synced: 2024-11-10T14:12:25.247Z (3 months ago)
- Topics: chinese-novels, github-actions, hcmus, nextjs, playwright, react, rsc, software-design, tailwindcss, vitest
- Language: TypeScript
- Homepage:
- Size: 352 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Thích Đọc Truyện
Software Design course final project.
Story reading web application with capabilities to search, read, and enjoy a variety types of story on the Internet (We do not steal them, we just use them as academic material).
Should there be any inconvience to you who owns a story we use, please kindly contact us for resolution.
## Team members
| Student ID | Full Name |
| ---------- | ---------------- |
| 21120502 | Trần Đức Minh |
| 21120515 | Trần Phước Nhân |
| 21120519 | Lê Thanh Phát |
| 21120521 | Nguyễn Phúc Phát |
| 21120524 | Trương Minh Phát |
## Features - Client Side
- Search for a story by name or author name from a story source
- Display details of a story (story title, description, number of chapters, genres, etc.) and chapter list
- Choose a specific chapter to read (the story content is formatted a bit)
- UI elements of the reading pad can be adjusted (background color, font family, font size)
- Chapter detail can be saved to local as PDF, EPUB, and images
- Switch the source of a chapter detail if possible
- Quickly navigate to previous, next, or a specific chapter
- Save reading history to local
## Prerequisites
1. [Node](https://nodejs.org/en) >= v18.21 (For the pnpm to work)
2. [pnpm](https://pnpm.io/) >= 9.1.0
## Getting started with this project
Create `.env` or `.env.local` file and fill all the variables (see `.env.example`)
```
# Backend API URL
NEXT_PUBLIC_API_URL=
```
Install dependencies
```bash
pnpm i
```
Spin up the `dev` server
```bash
pnpm run dev
```
You can run tests (for fun)
```bash
pnpm run test # unit & integration tests (vitest)
```
```bash
pnpm run test:ese # e2e tests (playwright)
```
## Acknowledgements
- I am, [@tmphat1312](https://github.com/tmphat1312), the only one who maintains this project will abandon it when the Software Design course ends.
- Actions in this repo are just for demo only (I just got my hands dirty with GitHub Actions)
- There was a getting started option with Docker. However I ran into problem wiht node-18 lately and decided to quit (I'm new to Docker btw)
- You can use this repo (I don't care anyway), but be careful with hidden code smell and bugs.
## License
[The Unlicense](https://choosealicense.com/licenses/unlicense/#)