swadhin / gellary public

Update README.md

Swadhin Biswas committed 2 years ago
8642c3a
1 parent a93ff3e
commit 8642c3a
1 file changed
+92 -0
Showing 1 changed file+92-0
README.md
▼README.md
+92-0
@@ -2,3 +2,95 @@
2
2
This project aims to create an image gallery website that fetches images from copyright-free sources, stores them in a database, and displays them on the website. We'll prioritize ethical considerations and legal compliance throughout the process.
3
3
4
4
#
5
+
6
+
7
+
8
+## `project code name: project Art`
9
+
10
+# project details:
11
+
12
+1. **Programming Language & Framework:** We'll use **Python** as it is beginner-friendly and widely used. Popular frameworks Fast API and React simplify web development. Choose the one you find more comfortable.
13
+2. **Libraries:**
14
+ - **requests**: Downloads images from the internet.
15
+ - **Database library**: Choose one based on your chosen database (e.g., `psycopg2` for PostgreSQL, `MySQLdb` for MySQL).
16
+ - **PIL (Python Imaging Library)**: Manipulates and displays images in Python.
17
+
18
+ **Building the Backend (Server-side)**
19
+
20
+ 1. **Database Setup:**
21
+ - Create a database table to store image data. Include columns for:
22
+ - **Image ID (unique identifier for each image)**
23
+ - **Image Data (byte string representing the image)**
24
+ - **Image Source URL (link to the original image source)**
25
+ - **Description (optional, a brief description of the image)**
26
+ - **License (optional, the specific license under which the image is available)**
27
+
28
+ 2. **Develop functionalities:**
29
+ - **Image fetching:** Write code using `requests` to download images from chosen URLs with proper error handling.
30
+ - **Image conversion:** Convert downloaded images to a byte string format using libraries like `PIL` before storing them in the database.
31
+ - **Data storage:** Use your chosen database library to establish a connection and store the image data and related information in the table you created.
32
+
33
+
34
+**Building the Front end (Website)**
35
+
36
+- We will use React to build our front end.
37
+- front-end Design sample given blew
38
+
39
+**Why Vite & React?**
40
+
41
+- **Vite:** This build tool offers lightning-fast development server starts and super-efficient Hot Module Replacement (HMR), making your work feel incredibly smooth and responsive.
42
+- **React:** This component-based JavaScript library empowers you to build modular, reusable, and interactive user interfaces, which fits perfectly with the dynamic nature of an image gallery.
43
+
44
+# Sample for Start Project With Vite
45
+
46
+`git clone [https://github.com/swadhinbiswas/Gellary](https://github.com/swadhinbiswas/Gellary)`
47
+
48
+[https://github.com/swadhinbiswas/Gellary](https://github.com/swadhinbiswas/Gellary)
49
+
50
+`cd Gellary/frontend`
51
+
52
+ `npm create vite@latest {project name} --template react
53
+ cd {project name}`
54
+
55
+`npm install axios`
56
+
57
+`npm install`
58
+
59
+`npm run dev`
60
+
61
+
62
+
63
+
64
+
65
+# **Resource**
66
+
67
+## for visual chats
68
+
69
+1.Chart.js
70
+
71
+[Chart.js](https://www.chartjs.org/)
72
+
73
+## database
74
+
75
+PostgreSQL
76
+
77
+[Set up hosted PostgreSQL® database for FREE](https://aiven.io/free-postgresql-database)
78
+
79
+API Fetching
80
+
81
+[GraphQL | A query language for your API](https://graphql.org/)
82
+
83
+UI for React
84
+
85
+[MUI: The React component library you always wanted](https://mui.com/)
86
+
87
+Caching
88
+
89
+[Redis](https://redis.io/)
90
+
91
+## Auth Provider
92
+
93
+[Auth0: Secure access for everyone. But not just anyone.](https://auth0.com/)
94
+
95
+# Design
96
+
5
97