Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AdoshSingh authored Jan 25, 2024
1 parent 3e26ce6 commit f157a86
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions photo-upload-app/README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,32 @@
# Photo Upload Directory
# Photo Upload Directory ![ workflow](https://github.com/devzero-inc/samples/actions/workflows/main.yml/badge.svg)

## Overview
The Photo Upload App is a streamlined and user-friendly platform designed for the effortless uploading and management of photos. Perfect for individuals looking to store, organize, and access their memories in the cloud, our app stands out for its intuitive design and reliable performance, ensuring your precious moments are always just a few clicks away.

![Alt Text](https://i.imgur.com/fYc1fAd.png)

## Table of contents
- [TODO](#todo)
- [Features](#features)
- [Technologies Used](#technologies-used)
- [High Level Design](#high-level-design)
- [Tech Stack](#tech-stack)

## TODO:
1. Write unit test for Backend routes.
1. Update HLD.

## Features
- **Pictures Management:** Streamline your photo collection with sophisticated yet user-friendly management features, ensuring your memories are neatly organized and always within reach.
- **Responsive Design:** Accessible on various devices and screen sizes.


## Technologies Used
- **Database:** PostgreSQL
- **Backend + Frontend:** Next.js
- **Styling:** TailwindCSS
## Technologies Used

- **Database:** [PostgreSQL](https://www.postgresql.org/)
- **Backend + Frontend:** [Next.js](https://nextjs.org/)
- **Styling:** [TailwindCSS](https://tailwindcss.com/)



## High Level Design

![Alt Text](https://i.imgur.com/XrHGDVc.jpg)
![Alt Text](https://i.imgur.com/q60nFCu.jpg)

Our Photo Upload App employs a Next.js-based architecture, integrating a PostgreSQL database for structured image data and a responsive frontend. The system handles image storage and API interactions seamlessly, ensuring real-time state updates and swift user interface re-renders for an efficient and intuitive user experience.

Expand All @@ -42,18 +39,19 @@ Our Photo Upload App employs a Next.js-based architecture, integrating a Postgre

## Installation

Dependencies:
**Dependencies:**
```
Docker version - 24.0.7
```
[Click here to download](https://www.docker.com/)


Run locally:
**Run locally:**
```bash
git clone https://github.com/devzero-inc/samples.git
cd samples/photo-upload-app
docker compose up -d
```
App will be running on ```PORT:3000``` -> [http://localhost:3000/](http://localhost:3000/)

Now just go to [http://localhost:3000/](http://localhost:3000/) and explore the application.
Now just go to [http://localhost:3000/](http://localhost:3000/) and explore the application.

0 comments on commit f157a86

Please sign in to comment.