Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions .env.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# WordWise
#
# Optional: server port (defaults to 3000)
# Copy this file to .env and fill in your values. NEVER commit the real .env file.

# Server port (defaults to 3000)
# PORT=3000

# Pexels API key for background media (get one free at https://pexels.com/api)
# PEXELS_API_KEY=***
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
node_modules/
.vercel
.env
.env.*
*.local
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ authors:
given-names: Sparsh
orcid: ''
license: AGPL-3.0-or-later
repository-code: 'https://github.com/sparshagarwal/wordwise'
repository-code: 'https://github.com/sparshsam/wordwise'
keywords:
- vocabulary
- language-learning
Expand Down
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@

WordWise is a single-page word-of-the-day app that serves a random English word on every visit — with its definition, phonetic pronunciation, a usage example, and a full-screen nature landscape photo or video background. It started as a hardcoded demo and grew into a polished, deployable product.

**Maturity:** Maintained. Releases, changelog, and issue tracking are active. See [ARCHITECTURE.md](docs/architecture.md) for system design.

---

## Features
Expand Down Expand Up @@ -229,6 +231,8 @@ The `vercel.json` routes all requests to the Express server.

```
wordwise/
├── docs/
│ └── architecture.md # System architecture and data flow
├── routes/
│ └── word.js # Word selection, dictionary lookup, Pexels fetch
├── views/
Expand Down Expand Up @@ -372,10 +376,25 @@ The ambition is not to become the biggest dictionary app. The ambition is to rem

---

## Limitations

WordWise is a read-only word display app. It does not:

- Store user history or preferences server-side
- Provide spaced repetition, quizzes, or learning tools
- Offer user accounts, authentication, or personalization
- Support offline word archives (browser-level caching only)
- Guarantee dictionary availability (depends on Free Dictionary API)
- Provide medical, legal, or academic definitions

## Contributing

Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, code style, and pull request guidelines.

## Citation

If you use WordWise in research or publications, please cite the repository using the metadata in [CITATION.cff](CITATION.cff).

## License

AGPL-3.0. See [LICENSE](LICENSE) for details.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"express": "^4.18.2"
},
"private": true,
"license": "MIT",
"license": "AGPL-3.0",
"author": "Sparsh Sam",
"repository": {
"type": "git",
Expand Down