You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+57-18Lines changed: 57 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,12 +2,37 @@
2
2
3
3
An online game that's like _Where's Waldo?_ but for houses
4
4
5
-
## Description
5
+
## Table of Contents
6
6
7
7
> [!NOTE]
8
8
> ALL CONTENTS IN THIS REPO ARE FOR EDUCATIONAL PURPOSES ONLY.
9
9
10
-
_Geofinder_ is an online scavenger hunt game. Its gameplay is simple: Given a photo of a house somewhere in the world, your task is to look for that house inside a marked area on a map. While that may sound straighforward, how you will go about looking might not be.
10
+
*[Description](#description)
11
+
*[Target Users](#target-users)
12
+
*[Features](#features)
13
+
*[Project Structure](#project-structure)
14
+
*[Prerequisites](#prerequisites)
15
+
*[Quick Start](#quick-start)
16
+
*[Local Setup](#local-setup)
17
+
*[Dependencies](#dependencies)
18
+
*[Installation](#installation)
19
+
*[Configuration](#configuration)
20
+
*[Production Setup](#production-setup)
21
+
*[Usage](#usage)
22
+
*[System Administration](#system-administration)
23
+
*[Author(s)](#authors)
24
+
*[Version History](#version-history)
25
+
*[Release Notes](#release-notes)
26
+
*[Initial Release](#initial-release)
27
+
*[Future Work](#future-work)
28
+
*[License](#license)
29
+
*[Contributing](#contributing)
30
+
*[Acknowledgments](#acknowledgments)
31
+
*[Screenshots](#screenshots)
32
+
33
+
## Description
34
+
35
+
_Geofinder_ is an online scavenger hunt game. Its gameplay is simple: Given a photo of a house somewhere in the world, your task is to look for that house inside a marked area on a map. While that may sound straightforward, how you will go about looking might not be.
11
36
12
37
_Geofinder_ comes in two modes.
13
38
@@ -18,25 +43,27 @@ _Geofinder_ is inspired by such childhood games as _[Where's Waldo?](https://en.
18
43
19
44

20
45
21
-
More screenshots below.
22
-
23
-
## Table of Contents
46
+
## Target Users
24
47
25
-
TODO
48
+
* TBD
26
49
27
50
## Features
28
51
29
-
TODO
52
+
* TBD
30
53
31
54
## Project Structure
32
55
33
-
TODO
56
+
* TBD
34
57
35
58
## Prerequisites
36
59
37
-
TODO
60
+
* TBD
61
+
62
+
## Quick Start
38
63
39
-
## Getting Started
64
+
* TBD
65
+
66
+
## Local Setup
40
67
41
68
### Dependencies
42
69
@@ -71,7 +98,7 @@ TODO
71
98
72
99
5. **Set up a PostgreSQL Database:**
73
100
74
-
TODO
101
+
TBD
75
102
76
103
6. **Set up a Google Maps API Key:**
77
104
@@ -85,9 +112,17 @@ TODO
85
112
86
113
Create a file named `.env`in the `app` directory of the project and add the following variables:
87
114
88
-
TODO
115
+
TBD
116
+
117
+
### Configuration
118
+
119
+
* TBD
120
+
121
+
## Production Setup
89
122
90
-
### Usage
123
+
* TBD
124
+
125
+
## Usage
91
126
92
127
1. **Go into the app directory and run the command:**
93
128
@@ -101,11 +136,15 @@ TODO
101
136
102
137
3. **Register an account:**
103
138
104
-
TODO
139
+
TBD
105
140
106
141
4. **Login:**
107
142
108
-
TODO
143
+
TBD
144
+
145
+
## System Administration
146
+
147
+
* TBD
109
148
110
149
## Author(s)
111
150
@@ -119,7 +158,7 @@ TODO
119
158
120
159
### Initial Release
121
160
122
-
The [initial realease](https://github.com/ggeerraarrdd/geofinder/releases/tag/v1.0.0) of _Geofinder_, as _Geo50x_, was submitted as the final project for [CS50x: CS50's Introduction to Computer Science](https://cs50.harvard.edu/x/2023/) (HarvardX, 2023). Read the [project brief](https://cs50.harvard.edu/x/2023/project/) as of September 2023.
161
+
The [initial release](https://github.com/ggeerraarrdd/geofinder/releases/tag/v1.0.0) of _Geofinder_, as _Geo50x_, was submitted as the final project for [CS50x: CS50's Introduction to Computer Science](https://cs50.harvard.edu/x/2023/) (HarvardX, 2023). Read the [project brief](https://cs50.harvard.edu/x/2023/project/) as of September 2023.
123
162
124
163
## Future Work
125
164
@@ -131,12 +170,12 @@ Development is ongoing.
131
170
132
171
## Contributing
133
172
134
-
TODO
173
+
* TBD
135
174
136
175
## Acknowledgments
137
176
138
177
* The distribution code for CS50's Finance problem served as a template for the app.
139
-
* The documentionsfor the Google Maps Platform were a daily, often hourly, read.
178
+
* The documentationsfor the Google Maps Platform were a daily, often hourly, read.
140
179
* Too many StackOverflow [Q&As](https://meta.stackoverflow.com/questions/267822/if-stack-overflow-doesnt-have-threads-what-the-heck-should-they-be-called) and Medium articles to mention but a couple proved immensely useful in developing two key functions
141
180
* [Offset Latitude and Longitude by some meters accurately - Reverse Haversine](https://gis.stackexchange.com/questions/411859/offset-latitude-and-longitude-by-some-meters-accurately-reverse-haversine)
142
181
* [Algorithm for offsetting a latitude/longitude by some amount of meters](https://gis.stackexchange.com/questions/2951/algorithm-for-offsetting-a-latitude-longitude-by-some-amount-of-meters)
0 commit comments