DUMP INTERNSHIP

INTERNSHIP CUP PROJECT

📌 Description

Bay Obey is a full-stack web application designed to enhance boating safety in Croatia by delivering location-based alerts in accordance with official maritime laws. The centerpiece of the app is a dynamic, geolocation-powered interactive map that notifies users of important warnings in real time, depending on their current position at sea.

👥 Team

This project was a collaborative team effort including:

• 3 Developers (including myself)
• 2 Designers
• 2 Marketing Specialists
• 1 Multimedia Specialist

You can get insight into promotional content on our instagram profile.

🚀 Key Features

• Real-time interactive Mapbox map with location-aware notifications
• Secure login and registration with JWT authentication
• Plan simulation with mock card payment
• Info page for reading into official Croatian maritime laws
• Emergency SOS button for fast access to sea rescue services
• Profile page where users can manage their personal and boat data
• Responsive UI supporting screen sizes from 375px (mobile) to 768px (tablet)

🛠️ Technologies

• Frontend: React, TypeScript, Vite, Axios, React Query, Mapbox GL JS
• Backend: NestJS, TypeScript, Prisma ORM, PostgreSQL (via Supabase), Swagger
• Development: Yarn, TurboRepo, Docker, Visual Studio Code, AWS (deployment)

📦 Installation and Running

Note: Docker is recommended but optional. If you already have PostgreSQL installed locally, you can manually create a database and skip Docker.

To run this project locally, you need to have the following installed:

1. Visual Studio Code (recommended)
2. Yarn
3. Node.js
4. Docker (or PostgreSQL via pgAdmin)

Steps to Install the Project:

1. Clone and open the Repository: Open a terminal and run the following commands:

   git clone https://github.com/ivonaaaa/internship-cup.git
   cd internship-cup

2. Install the dependencies: Once you're in the VS Code, open a terminal and type in this command in root directory:

   yarn install

3. Start Docker: If you don't have a local PorstgreSQL setup:

   docker compose up -d

   • Alternatively, open pgAdmin and create a new database named "bayobey-app". Take note of your connection credentials as you will use this in your .env file as DATABASE_URL.

4. Set up the environment variables:

   Create a .env file in the /backend directory:

   DATABASE_URL="postgresql://pomorac:more123@localhost:5432/bayobey-app"
   JWT_SECRET="your_jwt_secret_here"

   Create a .env file in the /frontend directory:

   VITE_ACCESS_TOKEN=pk.eyJ1IjoienVsamExMjMiLCJhIjoiY21hYjhyeTVrMXZ1azJsc2RjMGYxNm93OCJ9.2OyzlK3a8dViX2VAAWlqSA
   

5. Setup Database:

   yarn db:generate
   yarn db:migrate
   yarn db:seed

6. Start the application: Use Turborepo to start both workspaces:

   yarn dev

   Open in Browser:

   • Frontend: http://localhost:5173
   • Backend: http://localhost:3000/api
   • Swagger Documentation: http://localhost:3000/api/docs

📄 License

This project is licensed under the Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) License.

You are free to:

• Share — copy and redistribute the material in any medium or format
• Adapt — remix, transform, and build upon the material

Under the following terms:

• Attribution — You must give appropriate credit and indicate if changes were made.
• NonCommercial — You may not use the material for commercial purposes.

🔗 Read the full license here

© 2025 Bay Obey Team
Built during the DUMP Internship Program.