https://github.com/aericki/breakinglocations-frontend
A page dedicated to the breakdance community
https://github.com/aericki/breakinglocations-frontend
api-rest bboy bgirl breakdance breakers breaking dancer frontend maps netlify postgresql prisma railway supabase typescript
Last synced: 4 months ago
JSON representation
A page dedicated to the breakdance community
- Host: GitHub
- URL: https://github.com/aericki/breakinglocations-frontend
- Owner: aericki
- Created: 2025-02-19T19:55:34.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-22T02:15:21.000Z (4 months ago)
- Last Synced: 2025-02-22T03:17:56.944Z (4 months ago)
- Topics: api-rest, bboy, bgirl, breakdance, breakers, breaking, dancer, frontend, maps, netlify, postgresql, prisma, railway, supabase, typescript
- Language: TypeScript
- Homepage: https://beta-breakinglocations.netlify.app/
- Size: 164 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🏋️ Training Locations Registration Application
This is a project for a breaking training locations registration application, where users can register and view training locations on a map. The application uses hCaptcha to prevent spam and implements a search for municipalities and registered locations via the Nominatim API.
## 📋 Features
- **Training Locations Registration**: Allows users to register a training location by filling in information like name, address, city, state, and phone.
- **Location Mapping**: Users can click on the map to set latitude and longitude coordinates. The address is reverse-geocoded to display the corresponding address.
- **Bot Protection**: hCaptcha implementation to verify user authenticity during registration.
- **Map Display and Navigation**: View registered locations on an interactive map.
## 🚀 Technologies
The main technologies and libraries used in this project are:
- **React** + **TypeScript** for building the interface
- **React-Leaflet** for map display and interactions
- **hCaptcha** for bot protection
- **Axios** for API communication
- **Tailwind CSS** for styling
## 🔧 Installation
1. Clone the repository:
```bash
git clone https://github.com/aericki/breakinglocations-frontend.git
cd breakinglocations-frontend
```
2. Install dependencies:
```bash
npm install
```
or
```bash
yarn add && yarn
```
3. Start the frontend in the folder:
```bash
npm run dev
```
4. Access the application at `http://localhost:5173`.
## 📌 Usage
### Location Registration
Home Page.
1. Open the registration form.
2. Click on the map to set the exact location, which will automatically fill in the address.
3. Fill in the location details, if the address or city does not appear, enter it manually (name, address, city and phone).
4. Complete the hCaptcha and click "Register."
## ⚙️ API Endpoints
- **POST /api/register**: Registers a new training location.
- **GET /api/locations**: Returns all registered locations.
## 🤝 Contributing
1. Fork the project.
2. Create a branch for your feature (`git checkout -b feature/new-feature`).
3. Commit your changes (`git commit -m 'Add new feature'`).
4. Push to the branch (`git push origin feature/new-feature`).
5. Open a Pull Request.
---
Created by [Aéricki Ferreira](https://github.com/aericki) with 💙
Instagram: [@aery_abc](https://www.instagram.com/aerickiferreira)