Skip to content

Commit 14132a7

Browse files
author
Ariadne Engelbrecht
committed
Update readme.
1 parent ee389c9 commit 14132a7

2 files changed

Lines changed: 27 additions & 15 deletions

File tree

week_11__final-project/spelling_bee/README.md

Lines changed: 26 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,33 @@
22

33
We love playing the [Spelling Bee of the NY Times](https://www.nytimes.com/puzzles/spelling-bee).
44

5-
This is a version of Spelling Bee with the Urban Dictionary as its lexicon.
5+
So I thaught that this would make a fun challenge for me to implement. To give it a little spin, this is Spelling Bee with the Urban Dictionary as its lexicon.
66

7-
As we aren't English native speakers and we like to learn new words, the player is provided with a word's definition if the word is found in the dictionary.
7+
Also, as we aren't English native speakers, the player is provided with the definition of the word if the word is found in the dictionary.
88

9-
Protip: Click on the bee to get a new set of letters.
9+
_Protip_: Click on the bee to get a new set of letters!
10+
11+
## How to play
12+
13+
The game is played as follows:
14+
15+
1. Create as many words as you can by clicking on the given letters.
16+
2. The word must be at least 4 letters long.
17+
3. The word must contain the letter in the middle.
18+
4. All letters can be used multiple times.
19+
5. If the word is found in the dictionary, you're provided with its definition and the word is added to your word list.
20+
21+
## How to run the app, choose:
22+
23+
- [Run the app locally](#run-the-app-locally)
24+
- [Installation](#installation)
25+
- [Set up the database](#set-up-the-database)
26+
- [Configuration](#configuration)
27+
- [Run the app](#run-the-app)
28+
- [Run the app via Docker](#run-the-app-via-docker)
29+
- [Installation](#installation-1)
30+
- [Configuration](#configuration-1)
31+
- [Run the app](#run-the-app-1)
1032

1133
## Run the app locally
1234

@@ -74,14 +96,4 @@ docker run -p 8000:8000 -v "$(pwd)/data:/data" spelling-bee
7496

7597
The `$(pwd)/data:/data` part in the docker run command is used to mount the data directory to the /data directory inside the Docker container. This allows the container to access the dictionary.db.
7698

77-
You can now access the app on `http://127.0.0.1:8000/`.
78-
79-
## How to play
80-
81-
The game is played as follows:
82-
83-
1. Create as many words as you can by clicking on the given letters.
84-
2. The word must be at least 4 letters long.
85-
3. The word must contain the letter in the middle.
86-
4. All letters can be used multiple times.
87-
5. If the word is found in the dictionary, you're provided with its definition and the word is added to your word list.
99+
You can now access the app on `http://127.0.0.1:8000/`.

week_11__final-project/spelling_bee/fly.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# fly.toml app configuration file generated for urban-spelling-bee on 2023-06-19T16:21:29+02:00
1+
# fly.toml app configuration file generated for urban-spelling-bee on 2023-06-19T16:33:30+02:00
22
#
33
# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
44
#

0 commit comments

Comments
 (0)