Skip to content

Latest commit

 

History

History
130 lines (112 loc) · 3.5 KB

README.md

File metadata and controls

130 lines (112 loc) · 3.5 KB

Freedivah: Project Overview

“From Dive Tracking to Social Sharing”
Freedivah is an interactive platform that allows freedivers to mark and share their dive locations on a global map using national flag icons.

The name 'Freedivah' combines 'freediving' with my identity as a developer, reflecting both my passion for underwater exploration and my journey.

Key Features

  • Personalized Dive Map: Pin and save your dive locations on a global map.
  • Sharing and Connecting: Share your dive experiences and connect with divers worldwide.
  • Tracking and Documentation: Log and track your dives across different countries to monitor your progress.

Documentation

For more detailed information, refer to the following:

Development Considerations

Flexible and Scalable Architecture

  • Single-direction dependencies and modularity.
  • Loosely coupled systems through separation and abstraction of business logic, UI, and side effects.

Architecture

System Overview

graph TB
subgraph "Frontend (Next.js)"
Web[Web Application]
subgraph "FSD Architecture"
App[Application Layer]
Pages[Pages Layer]
Widgets[Widgets Layer]
Entities[Entities Layer]
Shared_FE[Shared Layer]
end
end
subgraph "Backend (Express.js)"
API[API Server]
subgraph "API Layers"
Routes[Routes]
Controllers[Controllers]
Services[Services]
Models[Models]
end
end
subgraph "Shared Package"
Types[Types]
Utils[Utils]
end
Web --> Types
Web --> Utils
API --> Types
API --> Utils
subgraph "External Services"
Supabase[(Supabase)]
end
API --> Supabase
Loading

Package Dependencies

graph TD
A[packages/web]
B[packages/api]
C[packages/shared]
A --> C
B --> C
style A fill:#eb6b56,stroke:#333,stroke-width:2px
style B fill:#2196F3,stroke:#333,stroke-width:2px
style C fill:#47b39d,stroke:#333,stroke-width:2px
Loading

Build Flow

graph LR
A[Build Shared] --> B[Build Web & API]
B --> C[Run Services]
style A fill:#47b39d,stroke:#333,stroke-width:2px
style B fill:#2196F3,stroke:#333,stroke-width:2px
style C fill:#eb6b56,stroke:#333,stroke-width:2px
Loading

Package Overview

  • @freedivah/shared: Core utilities and types
  • @freedivah/web: Next.js frontend application
  • @freedivah/api: Express backend server

Technologies Used

  • Frontend: Next.js, TypeScript, Vanilla Extract
  • Backend: Node.js, Express.js, Supabase
  • Testing: Jest
  • DevOps: Github Actions, Docker, AWS

How to Run

Prerequisites

  • Node.js 18+
  • PNPM 9.14.1+

Installation & Development

  1. Clone the repository 
    git clone https://github.com/f-lab-edu/Freedivah.git
cd Freedivah
  2. Install dependencies 
    pnpm install
  3. Start development 
    pnpm dev

Testing

yarn test

Build

yarn build

Design

Freedivah Design