tsuna-mi/ciutat-de-dones-map

Interactive map to allow users to explore Barcelona Women influential figures stories.

Barcelona. Ciutat de Dones - Interactive Map 🗺️

Project Overview 🌟

The "Barcelona. Ciutat de Dones" project is part of a Final Year Project (TFG) that aims to highlight the extraordinary contributions of numerous women who have left their mark on Barcelona and society. This interactive map is a visual and educational tool, allowing users to explore the influential figures and learn more about their stories.

Features 🛠️

• Interactive Map: Clickable nodes representing individual women who have contributed to Barcelona's heritage.
• Search Functionality: Users can search for specific names or filter by categories.
• Accessibility Focused: Implementing best practices to ensure the map is accessible to all users.

Technologies Used 💻

• ReactJS for building the user interface.
• Vite as a build tool for a blazing fast development experience.
• Chakra UI for a modular and accessible component library.
• Plus, other smaller dependencies listed in package.json.

Getting Started 🚀

To get a local copy up and running, follow these simple steps:

1. Clone the repo

   git clone https://github.com/Tsuna-mi/ciutat-de-dones-map.git

2. Install NPM packages.

   pnpm install

3. Start the server to serve the api.

   pnpm run serve:api

4. Serve with hot reload at http://localhost:5173.

   pnpm dev

Recommended VS Code extensions

• ESLint
• Prettier
• vscode-styled-components

Available Scripts 📜

In the project directory, you can run:

• pnpm run dev: Runs the app in the development mode.
• pnpm run build: Builds the app for production.
• pnpm run serve: Preview the production build.
• pnpm run serve:api: Runs the JSON server for the API.
• pnpm run lint: Lints and formats your code.
• pnpm run format: Formats your code using Prettier.
• pnpm run prepare: Prepares husky for commit hooks.
• pnpm run cz: Runs commitizen for commit conventions.

Commit commands

This project use commitlint to ensure that commit messages are conventional-changelog compliants.

To help you build more efficient commit messages, you can use the commitizen package by running this command :

pnpm cz

Deployment 🌐

This project has been deployed using Netlify and is accessible at https://ciutat-de-dones.netlify.app.

Happy Exploring! 🎉

License

This project is licensed under the MIT License.