Skip to content

Commit 9d5fae3

Browse files
authored
docs: improve README (#2)
1 parent 2a17fda commit 9d5fae3

1 file changed

Lines changed: 20 additions & 9 deletions

File tree

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,43 @@
1-
# AddressData frontend
1+
# AddressData.net
22

33
<img src="docs/logo.svg" alt="Description" width="105">
44

5-
[![Deployment](https://github.com/ashtonav/addressdata-frontend/actions/workflows/addressdata-app-AutoDeployTrigger-1352a65f-b8b9-449e-a5dd-c191984e6a8c.yml/badge.svg)](https://github.com/ashtonav/addressdata-frontend/actions/workflows/addressdata-app-AutoDeployTrigger-1352a65f-b8b9-449e-a5dd-c191984e6a8c.yml)
6-
[![license](https://img.shields.io/github/license/ashtonav/addressdata-frontend.svg)](LICENSE)
5+
[![deployment](https://github.com/ashtonav/addressdata.net/actions/workflows/addressdata-app-AutoDeployTrigger-97565f4e-b488-43b4-bd79-af6dc76a766b.yml/badge.svg)](https://github.com/ashtonav/addressdata-frontend/actions/workflows/addressdata-app-AutoDeployTrigger-97565f4e-b488-43b4-bd79-af6dc76a766b.yml)
6+
[![license](https://img.shields.io/github/license/ashtonav/addressdata.net.svg)](LICENSE)
77

88
This code is used to power [AddressData.net](https://AddressData.net), a site that displays all known addresses by city, alongside an interactive map.
99

1010
Currently, [AddressData.net](https://AddressData.net) contains millions of addresses for over 1,500 cities around the world.
1111

1212
## Installation
1313

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:
1816

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.
2024

2125
## Acknowledgments
2226

2327
- **Datasette**:
2428
[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.
2529

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+
2636
## Contributing
2737

2838
Pull requests are accepted.
2939

3040
## License
3141

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

Comments
 (0)