Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/taginfo/taginfo
Brings together information about OpenStreetMap tags and makes it searchable and browsable
https://github.com/taginfo/taginfo
javascript openstreetmap ruby taginfo
Last synced: about 2 months ago
JSON representation
Brings together information about OpenStreetMap tags and makes it searchable and browsable
- Host: GitHub
- URL: https://github.com/taginfo/taginfo
- Owner: taginfo
- License: gpl-3.0
- Created: 2010-10-04T16:35:58.000Z (about 14 years ago)
- Default Branch: master
- Last Pushed: 2024-08-08T06:57:16.000Z (5 months ago)
- Last Synced: 2024-08-08T08:38:50.558Z (5 months ago)
- Topics: javascript, openstreetmap, ruby, taginfo
- Language: Ruby
- Homepage: https://wiki.openstreetmap.org/wiki/Taginfo
- Size: 6.16 MB
- Stars: 120
- Watchers: 13
- Forks: 92
- Open Issues: 68
-
Metadata Files:
- Readme: README.md
- Changelog: history.md
- License: LICENSE
Awesome Lists containing this project
README
# Taginfo
Brings together information about OpenStreetMap tags and makes it searchable
and browsable.
**Documentation:** See the
[Taginfo](https://wiki.openstreetmap.org/wiki/Taginfo) page at the OpenStreetMap
wiki.
**Live System:** [taginfo.openstreetmap.org](https://taginfo.openstreetmap.org/)
There is no versioning of these tools. The official site always runs the
version tagged `osmorg-taginfo-live`. If you are using the tools, we encourage
you to stay up-to-date with that version also. But monitor your setup closely
when you switch to a new version, sometimes things can break.
## Files
* `/sources` - import scripts
* `/web` - web user interface and API
* `/examples` - some misc example stuff
## Prerequisites
It uses:
* Ruby (must be at least 3.0)
* [Sinatra web framework](http://www.sinatrarb.com/) and other ruby libraries
* curl binary
* sqlite3 binary (version 3.33 or above with FTS5 and regexp support)
* Optional: Parallel bzip (pbzip2)
Install the Debian/Ubuntu packages:
```sh
$ sudo apt-get install curl sqlite3
$ sudo apt-get install ruby-passenger libapache2-mod-passenger
```
Install the Gems:
```sh
$ sudo gem install bundler
$ sudo bundle install
```
Depending on your setup you might want to install an application server like
* [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/) or
* Apache2 `mod_passenger`
If you want to create the taginfo database yourself, you need to have
https://github.com/taginfo/taginfo-tools installed. See there for details.
If you only want to run the UI and get the database from somewhere else,
you do not need this.
## Data Import
See [Taginfo/Installation](https://wiki.openstreetmap.org/wiki/Taginfo/Installation)
at OpenStreetMap's wiki.
## Web User Interface
You need a `/data` directory (in the parent directory of the directory where
this `README.md` is). It must contain the sqlite database files created in the
data import step or downloaded from page
[taginfo.openstreetmap.org/download](https://taginfo.openstreetmap.org/download).
To start the web user interface:
```sh
cd web
./taginfo.rb
```
You can also use it via [uWSGI](https://uwsgi-docs.readthedocs.io/en/latest/).
(On Debian install these packages: `uwsgi uwsgi-core uwsgi-plugin-rack-ruby3.1`.)
```sh
cd web
bundle exec uwsgi uwsgi.ini
```
You can change various settings in the [config file](web/uwsgi.ini) and use
it through a web server like Apache2 or Nginx.
## Tests
There are a few tests for the Ruby code. Call `rake` in the `web` directory to
run the tests.
## Rubocop
There is a configuration for [Rubocop](https://rubocop.org/). You can run
Rubocop with `rubocop FILENAME.rb...` to check one or more Ruby files. Fixing
issues is currently an ongoing process.
## Javascript
Taginfo uses the following Javascript libraries:
* [d3](https://d3js.org/)
All the Javascript and CSS needed is already included.
## Thanks
To the [many people](https://github.com/taginfo/taginfo/graphs/contributors)
helping with bug reports, code and translations.
## Contact
There is a mailing list for developers and people running their own instances
of taginfo:
[taginfo-dev](https://lists.openstreetmap.org/listinfo/taginfo-dev)
## Author
Jochen Topf ([email protected]) - https://jochentopf.com/