Skip to content

Commit af8eaf8

Browse files
Priyansh-maxPriyansh-max
authored
Update README.md (#81)
1 parent d8b9ae5 commit af8eaf8

File tree

1 file changed

+260
-4
lines changed

1 file changed

+260
-4
lines changed

‎README.md‎

Lines changed: 260 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,263 @@
1-
# Inpact Landing Page
1+
![Inpact arch](https://github.com/user-attachments/assets/2b911c1f-2a14-4663-9a22-f04b22baa5b8)
22

3-
**This repository is a fork of [ishaanxgupta/Inpact-LandingPage](https://github.com/ishaanxgupta/Inpact-LandingPage).**
3+
# Inpact - AI-Powered Creator Collaboration & Sponsorship Matchmaking
44

5-
Special thanks and credit to **Ishaan Gupta** ([ishaanxgupta](https://github.com/ishaanxgupta)) for building the landing page to this level.
5+
Inpact is an open-source AI-powered platform designed to connect content creators, brands, and agencies through data-driven insights. By leveraging Generative AI (GenAI), audience analytics, and engagement metrics, Inpact ensures highly relevant sponsorship opportunities for creators while maximizing ROI for brands investing in influencer marketing.
66

7-
---
7+
## Features
8+
9+
### AI-Driven Sponsorship Matchmaking
10+
11+
- Automatically connects creators with brands based on audience demographics, engagement rates, and content style.
12+
13+
### AI-Powered Creator Collaboration Hub
14+
15+
- Facilitates partnerships between creators with complementary audiences and content niches.
16+
17+
### AI-Based Pricing & Deal Optimization
18+
19+
- Provides fair sponsorship pricing recommendations based on engagement, market trends, and historical data.
20+
21+
### AI-Powered Negotiation & Contract Assistant
22+
23+
- Assists in structuring deals, generating contracts, and optimizing terms using AI insights.
24+
25+
### Performance Analytics & ROI Tracking
26+
27+
- Enables brands and creators to track sponsorship performance, audience engagement, and campaign success.
28+
29+
## Tech Stack
30+
31+
- **Frontend**: ReactJS
32+
- **Backend**: FastAPI
33+
- **Database**: Supabase
34+
- **AI Integration**: GenAI for audience analysis and sponsorship recommendations
35+
36+
---
37+
38+
## Workflow
39+
40+
### 1. User Registration & Profile Setup
41+
42+
- Creators, brands, and agencies sign up and set up their profiles.
43+
- AI gathers audience insights and engagement data.
44+
45+
### 2. AI-Powered Sponsorship Matchmaking
46+
47+
- The platform suggests brands and sponsorship deals based on audience metrics.
48+
- Creators can apply for sponsorships or receive brand invitations.
49+
50+
### 3. Collaboration Hub
51+
52+
- Creators can find and connect with others for joint campaigns.
53+
- AI recommends potential collaborations based on niche and audience overlap.
54+
55+
### 4. AI-Based Pricing & Contract Optimization
56+
57+
- AI provides fair pricing recommendations for sponsorships.
58+
- Auto-generates contract templates with optimized terms.
59+
60+
### 5. Campaign Execution & Tracking
61+
62+
- Creators execute sponsorship campaigns.
63+
- Brands track campaign performance through engagement and ROI metrics.
64+
65+
### 6. Performance Analysis & Continuous Optimization
66+
67+
- AI analyzes campaign success and suggests improvements for future deals.
68+
- Brands and creators receive insights for optimizing future sponsorships.
69+
70+
---
71+
72+
## Getting Started
73+
74+
### Prerequisites
75+
76+
Ensure you have the following installed:
77+
78+
- Node.js & npm
79+
- Python & FastAPI
80+
- Supabase account
81+
82+
### Installation
83+
84+
#### 1. Clone the repository
85+
86+
```sh
87+
git clone https://github.com/AOSSIE-Org/InPact.git
88+
cd inpact
89+
```
90+
91+
#### 2. Frontend Setup
92+
93+
1. Navigate to the frontend directory:
94+
```sh
95+
cd frontend
96+
```
97+
98+
2. Install dependencies:
99+
```sh
100+
npm install
101+
```
102+
103+
3. Create a `.env` file using `.env-example` file:
104+
105+
106+
4. Get your Supabase credentials:
107+
- Go to [Supabase](https://supabase.com/)
108+
- Log in and create a new project (or use existing)
109+
- Go to Project Settings -> API
110+
- Copy the "Project URL" and paste it as VITE_SUPABASE_URL
111+
- Copy the "anon public" key and paste it as VITE_SUPABASE_ANON_KEY
112+
113+
#### 3. Backend Setup
114+
115+
1. Navigate to the backend directory:
116+
```sh
117+
cd ../backend
118+
```
119+
120+
2. Install dependencies:
121+
```sh
122+
pip install -r requirements.txt
123+
```
124+
125+
3. Navigate to the app directory:
126+
```sh
127+
cd app
128+
```
129+
130+
4. Create a `.env` file using `.env-example` as a reference.
131+
132+
5. Obtain Supabase credentials:
133+
- Go to [Supabase](https://supabase.com/)
134+
- Log in and create a new project
135+
- Click on the project and remember the project password
136+
- Go to the **Connect** section at the top
137+
- Select **SQLAlchemy** and copy the connection string:
138+
139+
```sh
140+
user=postgres
141+
password=[YOUR-PASSWORD]
142+
host=db.wveftanaurduixkyijhf.supabase.co
143+
port=5432
144+
dbname=postgres
145+
```
146+
147+
--OR--
148+
149+
[The above works in ipv6 networks, if you are in ipv4 network or it cause errors, use the below connection string which could be found in Session Pooler connection]
150+
151+
```sh
152+
user=postgres.<project>
153+
password=[YOUR-PASSWORD]
154+
host=aws-<location>.pooler.supabase.com
155+
port=5432
156+
dbname=postgres
157+
```
158+
159+
6. Get the Groq API key:
160+
- Visit [Groq Console](https://console.groq.com/)
161+
- Create an API key and paste it into the `.env` file
162+
163+
#### 4. Start Development Servers
164+
165+
1. Start the frontend server (from the frontend directory):
166+
```sh
167+
npm run dev
168+
```
169+
170+
2. Start the backend server (from the backend/app directory):
171+
```sh
172+
uvicorn main:app --reload
173+
```
174+
175+
## Data Population
176+
177+
To populate the database with initial data, follow these steps:
178+
179+
1. **Open Supabase Dashboard**
180+
181+
- Go to [Supabase](https://supabase.com/) and log in.
182+
- Select your created project.
183+
184+
2. **Access the SQL Editor**
185+
186+
- In the left sidebar, click on **SQL Editor**.
187+
188+
3. **Run the SQL Script**
189+
- Open the `sql.txt` file in your project.
190+
- Copy the SQL queries from the file.
191+
- Paste the queries into the SQL Editor and click **Run**.
192+
193+
This will populate the database with the required initial data for the platform. 🚀
194+
195+
---
196+
197+
## Contributing
198+
199+
We welcome contributions from the community! To contribute:
200+
201+
1. Fork the repository.
202+
2. Create a new branch for your feature (`git checkout -b feature-name`).
203+
3. Commit your changes (`git commit -m "Added feature"`).
204+
4. Push to your branch (`git push origin feature-name`).
205+
5. Open a Pull Request.
206+
207+
---
208+
209+
## Overall Workflow
210+
211+
```mermaid
212+
graph TD;
213+
A[User Signup/Login] -->|via Supabase Auth| B[User Dashboard];
214+
B -->|Fetch Audience & Engagement Data| C[AI-Powered Sponsorship Matchmaking];
215+
C -->|Suggest Ideal Brand Deals| D[Creator Applies for Sponsorship];
216+
D -->|Submit Application| E[Brand Reviews & Shortlists];
217+
E -->|AI-Based Pricing & Negotiation| F[Contract Generation via AI];
218+
F -->|Sign Deal| G[Sponsorship Execution];
219+
G -->|Track Performance| H[AI-Powered ROI Analytics];
220+
H -->|Optimized Insights| I[Brands & Creators Adjust Strategies];
221+
I -->|Feedback Loop| C;
222+
```
223+
224+
**FRONTEND workflow in detail**
225+
226+
```mermaid
227+
graph TD;
228+
A[User Visits Inpact] -->|Supabase Auth| B[Login/Signup];
229+
B -->|Fetch User Profile| C[Dashboard Loaded];
230+
C -->|Request AI-Powered Matches| D[Fetch Sponsorship Deals via API];
231+
D -->|Display Relevant Matches| E[User Applies for Sponsorship];
232+
E -->|Send Application via API| F[Wait for Brand Response];
233+
F -->|Fetch Application Status| G[Show Application Updates];
234+
G -->|If Approved| H[Contract Generation Page];
235+
H -->|AI Drafts Contract| I[User Reviews & Signs Contract];
236+
I -->|Start Campaign Execution| J[Track Sponsorship Performance];
237+
J -->|Show Performance Analytics| K[AI Optimizes Future Matches];
238+
```
239+
240+
**BACKEND workflow in detail**
241+
242+
```mermaid
243+
graph TD;
244+
A[User Authentication] -->|Supabase Auth API| B[Verify User];
245+
B -->|Store User Data in DB| C[Return JWT Token];
246+
C -->|Fetch User Profile| D[Return Profile Data];
247+
D -->|Receive Sponsorship Match Request| E[Query AI Engine];
248+
E -->|Analyze Audience & Engagement| F[Generate Sponsorship Matches];
249+
F -->|Return Matches via API| G[Send to Frontend];
250+
G -->|User Applies for Sponsorship| H[Store Application in DB];
251+
H -->|Notify Brand| I[Brand Reviews Application];
252+
I -->|Brand Approves/Rejects| J[Update Application Status];
253+
J -->|If Approved| K[Generate AI-Powered Contract];
254+
K -->|AI Suggests Pricing & Terms| L[Store Finalized Contract in DB];
255+
L -->|Track Campaign Performance| M[Analyze Engagement & ROI];
256+
M -->|Return Insights| N[AI Refines Future Recommendations];
257+
```
258+
259+
## Contact
260+
261+
For queries, issues, or feature requests, please raise an issue or reach out on our Discord server.
262+
263+
Happy Coding!

0 commit comments

Comments
 (0)