wieerwill/augsburg-mosaic
1
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases Wiki Activity
a digital guide, offering a curated list of places categorized as Attractions, Food spots, Cultural hubs, Nature retreats, and Others
2 Commits 4 Branches 0 Tags 1.9 MiB
Vue 87.7%
TypeScript 7.1%
JavaScript 5.2%
main
Go to file
wieerwill 90a9d1cdd0 add favicon
2023-11-01 20:41:40 +01:00
assets initial version 2023-11-01 20:27:34 +01:00
components add favicon 2023-11-01 20:41:40 +01:00
mixins initial version 2023-11-01 20:27:34 +01:00
pages initial version 2023-11-01 20:27:34 +01:00
public add favicon 2023-11-01 20:41:40 +01:00
store initial version 2023-11-01 20:27:34 +01:00
.gitignore initial version 2023-11-01 20:27:34 +01:00
.npmrc initial version 2023-11-01 20:27:34 +01:00
app.vue initial version 2023-11-01 20:27:34 +01:00
nuxt.config.ts add favicon 2023-11-01 20:41:40 +01:00
package.json initial version 2023-11-01 20:27:34 +01:00
pnpm-lock.yaml initial version 2023-11-01 20:27:34 +01:00
README.md initial version 2023-11-01 20:27:34 +01:00
screenshot.png initial version 2023-11-01 20:27:34 +01:00
tsconfig.json initial version 2023-11-01 20:27:34 +01:00

README.md

Augsburg Mosaic

This project blossomed from a genuine fondness for the city of Augsburg, aiming to unfold its hidden gems and notable locales to both visitors and residents alike.

Project Screenshot

Project Overview

Augsburg Mosaic serves as a digital guide, offering a curated list of places categorized as Attractions, Food spots, Cultural hubs, Nature retreats, and Others. Through an interactive map and a user-friendly list, one can explore, filter, and learn more about each location.

Utilizing technologies such as Vue.js, Nuxt.js, Leaflet.js for map rendering, and Pinia for state management, this project embodies a seamless blend of design and functionality, all while being a purely static site optimized for SEO. This also means, there are no cookies or any other data collection mechanisms involved, especially not concerning personal data.

This endeavor is purely a hobby, unfunded yet rich in spirit. The icons embellishing this site are courtesy of FontAwesome, while the images are captured through the lens of WieErWill.

Getting Started

Prerequisites

  • Ensure you have Node.js installed on your machine.
  • This project uses pnpm as the package manager. Install it globally using npm install -g pnpm.

Setup

  1. Fork this repository to your GitHub account.
  2. Clone your forked repository to your local machine: git clone https://github.com/wieerwill/augsburg-mosaic.git
  3. Navigate to the project directory: cd augsburg-mosaic
  4. Install the project dependencies: pnpm install
  5. Start the development server: pnpm dev

The project should now be running on http://localhost:3000.

Building

To build the static version of the project, run:

pnpm generate

The static files will be generated in the dist directory, ready to be deployed. Contributing

Feel free to explore, report issues, or open pull requests. If you find this project useful, please consider giving it a star! ⭐

License

This project is open-source and available under the MIT License.

Acknowledgements

Icons provided by FontAwesome.

Map rendering powered by Leaflet.js.

Enjoy traversing through the mosaic of Augsburg!