Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kvanrooyen/osm-profile
A modern, simple OSM profile built with React.
https://github.com/kvanrooyen/osm-profile
openstreetmap reactjs
Last synced: 3 months ago
JSON representation
A modern, simple OSM profile built with React.
- Host: GitHub
- URL: https://github.com/kvanrooyen/osm-profile
- Owner: Kvanrooyen
- License: gpl-3.0
- Created: 2024-06-03T20:13:21.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-09-28T23:42:02.000Z (3 months ago)
- Last Synced: 2024-10-12T19:23:38.929Z (3 months ago)
- Topics: openstreetmap, reactjs
- Language: JavaScript
- Homepage: https://osm.governorkeagan.com
- Size: 1.58 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GNU General Public License v3.0 License][license-shield]][license-url]
[![React][React.js]][React-url]
OSM Profile
A modern, simple OSM profile built with React.
Report Bug
·
Request Feature
Table of Contents
-
About The Project
-
Getting Started
- Prerequisites
- Installation
https://github.com/Kvanrooyen/osm-profilegraphs/contributors
- Roadmap
- Contributing
- License
- Contact
## About The Project
[![OSM Profile Screenshot][product-screenshot]](https://osm.governorkeagan.com/)
I built this over a weekend with the goal of creating a simplified and modern looking alternative (for myself) to ["How Did You Contribute"](https://hdyc.neis-one.org/). Currently, this project only serves my OSM data via the API but I may change that in the future.
## Getting Started
Getting this setup for your self is fairly straightforward. You only need to modify the `USER_ID` and `START_TIME` variables.
### Prerequisites
1. Ensure you have the latest version of `npm` installed on your device.
2. Navigate to https://api.openstreetmap.org/api/0.6/user/details.json and login with your OSM details.
* You will need the `id` and `account_created`
### Installation
1. Clone the repo
```sh
git clone https://github.com/Kvanrooyen/osm-profile.git
```
2. Install NPM packages
```sh
npm install
```
3. Enter your `id` and `account_created` in `osmApi.js`
```js
const USER_ID = 'ENTER YOUR ID';
const START_TIME = 'ENTER YOUR START TIME';
```
## Roadmap
- [ ] Contribution Heatmap
- [ ] Social Links
See the [open issues](https://github.com/Kvanrooyen/osm-profile/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the GNU General Public License v3.0 License. See `LICENSE` for more information.
## Contact
Mastodon: [@[email protected]](https://en.osm.town/@governorkeagan) · Matrix: `@governorkeagan:matrix.org`
[contributors-shield]: https://img.shields.io/github/contributors/Kvanrooyen/osm-profile.svg?style=for-the-badge
[contributors-url]: https://github.com/Kvanrooyen/osm-profile/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Kvanrooyen/osm-profile.svg?style=for-the-badge
[forks-url]: https://github.com/Kvanrooyen/osm-profile/network/members
[stars-shield]: https://img.shields.io/github/stars/Kvanrooyen/osm-profile.svg?style=for-the-badge
[stars-url]: https://github.com/Kvanrooyen/osm-profile/stargazers
[issues-shield]: https://img.shields.io/github/issues/Kvanrooyen/osm-profile.svg?style=for-the-badge
[issues-url]: https://github.com/Kvanrooyen/osm-profile/issues
[license-shield]: https://img.shields.io/github/license/Kvanrooyen/osm-profile.svg?style=for-the-badge
[license-url]: https://github.com/Kvanrooyen/osm-profile/blob/master/LICENSE.txt
[product-screenshot]: docs/assets/screenshot.png
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/