osm-profile

<a href="https://github.com/Kvanrooyen/osm-profile/issues/new?labels=enhancement&template=feature_request.md">Request Feature</a>

About The Project

I built this over a weekend with the goal of creating a simplified and modern looking alternative (for myself) to "How Did You Contribute". 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

   git clone https://github.com/Kvanrooyen/osm-profile.git
   

2. Install NPM packages

   npm install
   

3. Enter your id and account_created in osmApi.js

   const USER_ID = 'ENTER YOUR ID';
   const START_TIME =  'ENTER YOUR START TIME';
   

Roadmap

• Contribution Heatmap
• Social Links

See the open 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] Matrix: @governorkeagan:matrix.org