Skip to content

Commit 8ecf864

Browse files
authored
docs: add a simple README (#1)
1 parent ac110bb commit 8ecf864

4 files changed

Lines changed: 54 additions & 3 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# AddressData frontend
2+
3+
<img src="docs/logo.svg" alt="Description" width="105">
4+
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)
7+
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+
10+
Currently, [AddressData.net](https://AddressData.net) contains millions of addresses for over 1,500 cities around the world.
11+
12+
## Installation
13+
14+
```bash
15+
cd src
16+
docker run -p 8001:8001 -it $(docker build -q .)
17+
```
18+
19+
It may take 10 minutes or more for docker build to be completed. Afterward, the website can be accessed at http://localhost:8001
20+
21+
## Acknowledgments
22+
23+
- **Datasette**:
24+
[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+
26+
## Contributing
27+
28+
Pull requests are accepted.
29+
30+
## License
31+
32+
[MIT](https://choosealicense.com/licenses/mit/)

docs/logo.svg

Lines changed: 22 additions & 0 deletions
Loading

readme.md

Whitespace-only changes.

run.ps1

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)