Update README
This commit is contained in:
66
README.md
66
README.md
@@ -2,7 +2,7 @@
|
||||
|
||||
<img src="showcase/surveilled.png" alt="showcase image" width="900">
|
||||
|
||||
Check out --> [Website](https://surveilled.quad4.io)
|
||||
Check out the live website at [surveilled.quad4.io](https://surveilled.quad4.io)
|
||||
|
||||
A map of cameras in the world using OpenStreetMap overpass data.
|
||||
|
||||
@@ -10,33 +10,75 @@ A map of cameras in the world using OpenStreetMap overpass data.
|
||||
|
||||
Data is fetched from OSM Overpass and may not be accurate or up to date as this data is community-sourced.
|
||||
|
||||
## Features
|
||||
|
||||
- Draw a box to get cameras for that area
|
||||
- Measure distance between two points/cameras
|
||||
- Export or copy GeoJSON of cameras in an area
|
||||
- Customize Nominatim, Overpass, and Tile endpoints
|
||||
- No reliance on external CDNs or Google fonts.
|
||||
- PWA installable
|
||||
- Mobile-friendly
|
||||
|
||||
## Self-hosting
|
||||
|
||||
### NPM
|
||||
|
||||
coming soon
|
||||
|
||||
### Docker
|
||||
|
||||
```sh
|
||||
docker run -p 3000:3000 git.quad4.io/quad4-software/surveilled:latest
|
||||
```
|
||||
|
||||
### Podman
|
||||
|
||||
```sh
|
||||
podman run -p 3000:3000 git.quad4.io/quad4-software/surveilled:latest
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```sh
|
||||
git clone https://git.quad4.io/Quad4-Software/Surveilled
|
||||
cd Surveilled
|
||||
```
|
||||
|
||||
### NPM
|
||||
|
||||
```sh
|
||||
npm install
|
||||
npm run dev
|
||||
```
|
||||
|
||||
### Makefile
|
||||
|
||||
```sh
|
||||
make dev
|
||||
```
|
||||
|
||||
## Building
|
||||
#### Check/Lint/Format
|
||||
|
||||
```sh
|
||||
make build
|
||||
make check
|
||||
make lint
|
||||
make format
|
||||
```
|
||||
|
||||
## Preview
|
||||
|
||||
```sh
|
||||
make preview
|
||||
```
|
||||
|
||||
## Docker
|
||||
## Building Docker Image
|
||||
|
||||
Uses Chainguard Images which are rootless and very minimal images.
|
||||
|
||||
```sh
|
||||
docker build -t surveilled .
|
||||
docker run -p 3000:3000 surveilled
|
||||
docker run --rm -p 3000:3000 surveilled
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Send email to [team@quad4.io](mailto:team@quad4.io) with your feedback or any issues you may have.
|
||||
|
||||
## LICENSE
|
||||
|
||||
[MIT](LICENSE)
|
||||
[MIT](LICENSE)
|
||||
|
||||
Reference in New Issue
Block a user