|
1 | | -# AddressData frontend |
| 1 | +# AddressData.net |
2 | 2 |
|
3 | 3 | <img src="docs/logo.svg" alt="Description" width="105"> |
4 | 4 |
|
5 | | -[](https://github.com/ashtonav/addressdata-frontend/actions/workflows/addressdata-app-AutoDeployTrigger-1352a65f-b8b9-449e-a5dd-c191984e6a8c.yml) |
6 | | -[](LICENSE) |
| 5 | +[](https://github.com/ashtonav/addressdata-frontend/actions/workflows/addressdata-app-AutoDeployTrigger-97565f4e-b488-43b4-bd79-af6dc76a766b.yml) |
| 6 | +[](LICENSE) |
7 | 7 |
|
8 | 8 | This code is used to power [AddressData.net](https://AddressData.net), a site that displays all known addresses by city, alongside an interactive map. |
9 | 9 |
|
10 | 10 | Currently, [AddressData.net](https://AddressData.net) contains millions of addresses for over 1,500 cities around the world. |
11 | 11 |
|
12 | 12 | ## Installation |
13 | 13 |
|
14 | | -```bash |
15 | | -cd src |
16 | | -docker run -p 8001:8001 -it $(docker build -q .) |
17 | | -``` |
| 14 | +### How to run |
| 15 | +1. From the root folder of the project, run the following commands: |
18 | 16 |
|
19 | | -It may take 10 minutes or more for docker build to be completed. Afterward, the website can be accessed at http://localhost:8001 |
| 17 | +2. ```bash |
| 18 | + docker build -t addressdatanet ./src |
| 19 | + docker run -it -p 8001:8001 addressdatanet |
| 20 | + ``` |
| 21 | +2. The API can be accessed at [http://localhost:8001](http://localhost:8001). |
| 22 | + |
| 23 | +FYI: The build script is a bit slow. It may take 20 minutes or more for docker build to be completed. |
20 | 24 |
|
21 | 25 | ## Acknowledgments |
22 | 26 |
|
23 | 27 | - **Datasette**: |
24 | 28 | [Datasette](https://docs.datasette.io/en/stable/) is used to display CSV data on a website. It offers a lightweight, flexible way to query and visualize structured data, making it easier to explore and share the address information we collect. |
25 | 29 |
|
| 30 | +- **OpenStreetMap** |
| 31 | + This repository includes data extracted from OpenStreetMap (via Overpass API). **Contains information from OpenStreetMap, © OpenStreetMap contributors.** Data is available under the **Open Database License (ODbL) 1.0**. |
| 32 | + |
| 33 | +- **Datasette Charcoal Theme** by https://github.com/julien040/charcoal-datasette-theme. |
| 34 | + |
| 35 | + |
26 | 36 | ## Contributing |
27 | 37 |
|
28 | 38 | Pull requests are accepted. |
29 | 39 |
|
30 | 40 | ## License |
31 | 41 |
|
32 | | -[MIT](https://choosealicense.com/licenses/mit/) |
| 42 | +- The code itself is licensed under [MIT](https://choosealicense.com/licenses/mit/). |
| 43 | +- The street addresses were retrieved using github.com/ashtonav/addressdata and are licensed/available under **Open Database License (ODbL) 1.0**. |
0 commit comments