Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rezoanulhasan/found-lost-backend

bycrypt expressjs jwt-authentication prisma typescript zod-validation

Last synced: 6 days ago
JSON representation

Host: GitHub
URL: https://github.com/rezoanulhasan/found-lost-backend
Owner: RezoanulHasan
Created: 2024-05-21T14:13:17.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-05-22T13:48:26.000Z (6 months ago)
Last Synced: 2024-05-22T21:23:23.145Z (6 months ago)
Topics: bycrypt, expressjs, jwt-authentication, prisma, typescript, zod-validation
Language: TypeScript
Homepage:
Size: 80.1 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Lost and Found System

Welcome to the Lost and Found System! This system is designed to simplify the process of reporting and claiming lost items. Whether you've found an item and want to reunite it with its owner or you're looking to claim a lost possession, this system has got you covered.

## Live-link: https://found-lost-frontend.vercel.app/

## Features

- **Report Found Items**: Users can report found items, providing details such as item name, description, location, and category.
- **Claim Lost Items**: Users can claim items they believe to be their lost possessions by providing relevant information and distinguishing features.
- **User Profiles**: Users have the option to create profiles, allowing them to share additional information about themselves.

## Technology use
- Prisma for PostgreSQL
- Node js
- Express js
- typescript
- JWT(validation)
- bcrypt (validation)
- Zod (validation)
- eslint ( code formatting and quality checking )
- prettier (maintain code structure)

## Proper Error handling
- Jwt Error
- Validation Error
- Cast Error
- Duplicate Entry
- Internal Server Error

## Models

1. **User Model**:
- Fields: id, name, email, password, createdAt, updatedAt
- Relationships: One-to-Many with FoundItem, One-to-Many with Claim, One-to-One with UserProfile

2. **FoundItemCategory Model**:
- Fields: id, name, createdAt, updatedAt

3. **FoundItem Model**:
- Fields: id, userId, categoryId, foundItemName, description, location, createdAt, updatedAt
- Relationships: Belongs to one User, Belongs to one FoundItemCategory

4. **Claim Model**:
- Fields: id, userId, foundItemId, status, distinguishingFeatures, lostDate, createdAt, updatedAt
- Relationships: Belongs to one User, Belongs to one FoundItem

5. **UserProfile Model**:
- Fields: id, userId, bio, age, createdAt, updatedAt
- Relationships: Belongs to one User

## API Documentation
### 1. User Registration
This endpoint handles user registration, creating both the user account and corresponding user profile simultaneously using a transactional approach.

**Endpoint**: `POST /api/register`
- **Method:** `POST`
- **Request Body:** data formate like this \*

```json

{
"name": "your_name",
"email": "[email protected]",
"password": "your_password",

"profile": {
"bio": "your_bio",
"age": your_age
}
}

```

### 2. User Login

- **Endpoint**: `POST /api/login`
- **Method:** `POST`
- **Request Body:** data formate like this \*

```json
{
"email": "your_email",
"password": "your_password"
}
```

### POST /lost-items
- Description: Report a lost item
- Request Body: JSON object containing details of the lost item
- Authentication Required: Yes
- Authorized Roles: USER, ADMIN, SuperAdmin

### GET /lost-items/:id
- Description: Retrieve a specific lost item by its ID
- Path Parameter:
- id: ID of the lost item
- Authentication Required: No

### PUT /lost-items/:id
- Description: Update a specific lost item by its ID
- Path Parameter:
- id: ID of the lost item
- Request Body: JSON object containing updated details of the lost item
- Authentication Required: Yes
- Authorized Roles: USER, ADMIN, SuperAdmin

### GET /lost-items
- Description: Retrieve all lost items
- Authentication Required: No

### DELETE /lost-items/:id
- Description: Delete a specific lost item by its ID
- Path Parameter:
- id: ID of the lost item
- Authentication Required: Yes
- Authorized Roles: USER, ADMIN, SuperAdmin

### GET /lost-items/user-lost
- Description: Retrieve lost items specific to the authenticated user
- Authentication Required: Yes
- Authorized Roles: USER, ADMIN, SuperAdmin
### POST /found-items
- Description: Report a found item
- Request Body: JSON object containing details of the found item
- Authentication Required: Yes
- Authorized Roles: USER, ADMIN, SuperAdmin

### GET /found-items/:id
- Description: Retrieve a specific found item by its ID
- Path Parameter:
- id: ID of the found item
- Authentication Required: No

### PUT /found-items/:id
- Description: Update a specific found item by its ID
- Path Parameter:
- id: ID of the found item
- Request Body: JSON object containing updated details of the found item
- Authentication Required: Yes
- Authorized Roles: USER, ADMIN, SuperAdmin

### GET /found-items
- Description: Retrieve all found items
- Authentication Required: No

### DELETE /found-items/:id
- Description: Delete a specific found item by its ID
- Path Parameter:
- id: ID of the found item
- Authentication Required: Yes
- Authorized Roles: USER, ADMIN, SuperAdmin

### GET /found-items/user-found
- Description: Retrieve found items specific to the authenticated user
- Authentication Required: Yes
- Authorized Roles: USER, ADMIN, SuperAdmin

### Create a Claim

Creates a Claim using the user's details extracted from the authorization token.

- **Endpoint**: `POST /api/claims`
- **Request Headers**:
- Authorization: ``

- **Request Body:** data formate like this \*

```json
{
"foundItemId": " use_ID",
"distinguishingFeatures": "write feature",
"lostDate": "2024-05-25T10:00:00Z"
}
```

### Get Claims

- **Endpoint**: `GET /api/claims`
- **Request Headers**:
- Authorization: ``

### Update Claim Status

- **Endpoint**: `PUT /api/claims/:claimId`
- **Request Headers**:
- Authorization: ``

- **Request Body:** data formate like this \*

```json
{
status:" APPROVED or REJECTED " ,

}
```

### Get Profile

- **Endpoint**: `GET /api/my-profile`
- **Request Headers**:
- Authorization: ``

### Update My Profile

- **Endpoint**: `PUT /api/my-profile`
- **Request Headers**:
- Authorization: ``

## For ADMIN

### Get all user by

- **Endpoint:** `/api/users`
- **Method:** `GET`
- **Access:** `admin`

### Get single user by ID

- **Endpoint:** `/api/users/:id`
- **Method:** `GET`
- **Access:** `admin`

### Delete a user
- Delete form user model and user profile
- **Endpoint:** `/api/users/:id`
- **Method:** `Delete`
- **Access:** `admin`

### Update a user
- Update user model and user profile
- **Endpoint:** `/api/users/:id`
- **Method:** `PATCH`
- **Access:** `admin`

## Contributing

Contributions are welcome! Please check out the [contribution guidelines](CONTRIBUTING.md).

## License

This project is licensed under the [MIT License](LICENSE).

## Getting Started

**Database Setup**:
- Ensure PostgreSQL is installed and running.
- Configure your database connection in the Prisma schema file (`schema.prisma`).
- Run migrations:
```
npx prisma migrate dev --name init
```
to set up and run projects locally
- download this repository
- npm install
- npm migrate
- npm run build
- npm run start: dev