Sketchboard

📋 Table of Contents

• Team Members
• Mentor
• Project Description
• Live Demo
• Technology Stack
• Database Setup
• Steps to Run
• Demo Account for Testing
• Data Flow Diagram
• Database Design
• Resource
• Bug Report
• Feature Request

Team Members

Name	Role	GitHub Profile
Asifur Rahman	Team Leader	asif17r
Souvik Sanyal	Member	souvik00
Sanjoy Kumar	Member	sanjoykumar-s

Mentor

• Piash-Haque

Project Description

Sketchboard is the team name for our project, Lost and Found. This project aims to create a platform where users can report lost items and search for found items. It helps in connecting people who have lost their belongings with those who have found them, making the process of recovering lost items more efficient and organized.

Live Demo

Visit

Technology Stack

• Backend: Spring Boot

• Frontend: React.js (Repository) (This frontend is for testing purposes only; the deployment frontend may differ significantly.)

• Database: PostgreSQL

• Containerization: Docker

• Build Tool: Maven

• Version Control: Git

Database Setup

The database will be created and configured automatically during application start-up using the spring-docker-compose dependency.

Steps to Run

1. Clone the Repository

   git clone [email protected]:Learnathon-By-Geeky-Solutions/sketchboard.git
   cd sketchboard

2. Run the application

   mvn clean install
   mvn spring-boot:run

Demo account for testing API endpoints

• Bearer Token

  eyJhbGciOiJIUzM4NCJ9.eyJzdWIiOiJhc2lmdXJyYWhtYW5wYWJlbEBnbWFpbC5jb20iLCJpYXQiOjE3NDYwMzE1MjQsImV4cCI6OTIyMzM3MjAzNjg1NDc3NX0.nHsSPGb3_Xlkrz6PElJhalfMw7GwYnqnTbtgKQEoD4OFvbztOlDD1lDNNKbB7WaM
  

• Or you can use login credentials

  Email: [email protected]
  Password: asif

Team Members

Name	Role	GitHub Profile
Asifur Rahman	Team Leader	asif17r
Souvik Sanyal	Member	souvik00
Sanjoy Kumar	Member	sanjoykumar-s

Mentor

• Piash-Haque

Data Flow Diagram

Level0 DFD:

Level1 DFD:

Database Design

The ER diagram illustrates our relational database structure,

Resource

• Project Planning
• Project Proposal

Bug Report

---

name: Bug report about: Create a report to help us improve title: '' labels: '' assignees: ''

---

Describe the bug A clear and concise description of what the bug is.

To Reproduce Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

Expected behavior A clear and concise description of what you expected to happen.

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

• OS: [e.g. iOS]
• Browser [e.g. chrome, safari]
• Version [e.g. 22]

Smartphone (please complete the following information):

• Device: [e.g. iPhone6]
• OS: [e.g. iOS8.1]
• Browser [e.g. stock browser, safari]
• Version [e.g. 22]

Additional context Add any other context about the problem here.

Feature Request

---

name: Feature request about: Suggest an idea for this project title: '' labels: '' assignees: ''

---

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Additional context Add any other context or screenshots about the feature request here.