Skip to content

Commit 8445b81

Browse files
authored
Create readme.md
1 parent 2c5b390 commit 8445b81

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

PhonaTick/readme.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# PhonaTick - A Word List for Confusing Pronunciations
2+
3+
## Description
4+
5+
The English language presents pronunciation challenges, especially for non-native speakers,
6+
due to its many vowel sounds and silent or extra letters in words.
7+
**PhonaTick** is a front-end for a list of words with tricky pronunciations (originally [saved in Google Sheets & retrieved using Google Sheets API](https://mvark.blogspot.com/2014/12/track-learn-about-aphonetic-words.html) but now fetched via [a JSON API through Datasette](http://mvark.blogspot.com/2025/03/datasette-open-source-tool-for-data.html)).
8+
It provides a searchable list of words with their pronunciations, sourced from Google and WordWeb
9+
(created by physicist Antony Lewis).
10+
11+
## Features
12+
13+
* **Word List:** A comprehensive list of English words with confusing pronunciations.
14+
* **Pronunciation Guide:** Pronunciations are provided using data from Google and WordWeb.
15+
* **Web Application:** The word list is accessible through a simple web application.
16+
* **Data Source:** The application uses a SQLite database generated from a CSV file.
17+
* **JSON API:** The data is exposed as a JSON API for easy access.
18+
19+
## Technologies Used
20+
21+
* **Datasette:** Used to convert the CSV file into a SQLite database, and to browse, filter, and explore the data.
22+
* **Glitch:** Hosts the Datasette instance and the web application.
23+
* **GitHub Copilot:** Used to generate the initial web app code.
24+
* **Visual Studio Code:** Code editor used for development.
25+
* **JavaScript:** Used to build the web application.
26+
27+
## Setup and Deployment
28+
29+
1. **CSV to SQLite:** The word list is stored in a CSV file. This file is converted into a SQLite database using Datasette.
30+
2. **Datasette Deployment:** The Datasette instance is self-hosted on Glitch. Glitch allows you to host web apps without managing servers.
31+
3. **Web App Deployment:** The web application is also deployed on Glitch.
32+
33+
## Usage
34+
35+
1. **Access the Web App:** The application can be accessed via a [Glitch link](https://cobalt-pie-astronaut.glitch.me/).
36+
2. **Browse the List:** Browse the list of words and their pronunciations.
37+
3. **Explore the Data:** [The data can be further explored using the Datasette interface](https://rightful-veiled-lyre.glitch.me/data/aphonetic).
38+
39+
## Credits
40+
41+
* **Data Source:** Google and WordWeb (Antony Lewis)
42+
* **Original Idea:** Inspired by the challenges of English pronunciation
43+
* **GitHub Copilot:** Helped in the rapid development of the web application.
44+
45+
## Author
46+
47+
* M.V. 'Anil' Radhakrishna ([@mvark](https://github.com/mvark))
48+
49+
## License
50+
51+
This project is open-source.
52+
53+
## Try it out!
54+
55+
You can try out the app on Glitch. Let the author know what you think!
56+
```

0 commit comments

Comments
 (0)