Skip to content

Commit 7218cd1

Browse files
pfranktestingclaude
andcommitted
Restore Running locally section with student note; restore adm-zip
Adds a callout clarifying that students don't need to install anything — the section is for developers only — then restores the npm install/dev instructions and adm-zip in the tech stack. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 20b0a14 commit 7218cd1

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,32 @@ Files are processed locally in your browser using the [File API](https://develop
7373

7474
---
7575

76+
## Running locally
77+
78+
> **Students:** You don't need to install anything. Just open [APA Coach](https://patrickfrankaiu.github.io/APA-Coach/) in your browser and upload your paper. This section is for developers who want to run or modify the source code.
79+
80+
```bash
81+
npm install
82+
npm run dev
83+
```
84+
85+
Then open `http://localhost:5173/APA-Coach/` and upload a `.docx` file.
86+
87+
To build for production:
88+
89+
```bash
90+
npm run build
91+
```
92+
93+
---
94+
7695
## Tech stack
7796

7897
- [Vite](https://vitejs.dev/) + [React](https://react.dev/) — build tooling and UI
7998
- [Node.js](https://nodejs.org/) — runtime for local development
8099
- [JSZip](https://stuk.github.io/jszip/) — in-browser `.docx` unpacking
81100
- [fast-xml-parser](https://github.com/NaturalIntelligence/fast-xml-parser) — XML parsing
101+
- [adm-zip](https://github.com/cthackers/adm-zip)`.docx` unpacking in the Node CLI
82102

83103
---
84104

0 commit comments

Comments
 (0)