Skip to content

Commit 51215e7

Browse files
authored
Create first-principle.mdx
1 parent 9da3edd commit 51215e7

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

docs/showcase/first-principle.mdx

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
## title: FirstPrinciples App | AI-Powered Learning Roadmaps description: An AI-powered learning roadmap generator that helps users identify specific learning topics and provides personalized learning plans. sidebar\_position: 1 keywords: [firstprinciples, learning, roadmap, education, AI, personalized, Flask, React, OpenAI, Perplexity]
2+
3+
**FirstPrinciples App** is an AI-powered tool that transforms your broad learning goals into structured, personalized roadmaps. Through an interactive chat, the AI engages you in a conversation, asking targeted questions to refine your learning needs before generating a detailed plan. The application is built to help you learn more efficiently by providing a clear path forward.
4+
5+
https://github.com/user-attachments/assets/6016c5dd-6c18-415e-b982-fafb56170b87
6+
7+
## Features
8+
9+
* **Interactive Chat Interface**: A simple, conversational interface for defining your learning goals.
10+
* **AI-Powered Topic Narrowing**: The AI asks smart, targeted questions to help you specify what you want to learn.
11+
* **Session Management**: Each conversation is a managed session, allowing you to have multiple roadmap discussions.
12+
* **Visual Progress Indicator**: See a visual cue when the AI has gathered enough information to generate your roadmap.
13+
14+
## Setup
15+
16+
### Getting Started
17+
18+
To get the project files, first clone the repository:
19+
20+
```
21+
git clone https://github.com/william-Dic/First-Principle.git
22+
cd First-Principle
23+
```
24+
25+
-----
26+
27+
### Backend Setup
28+
29+
1. Navigate to the Flask server directory:
30+
```
31+
cd flask-server
32+
```
33+
2. Install dependencies:
34+
```
35+
pip install -r requirements.txt
36+
```
37+
3. Create a `.env` file in the `flask-server` directory with your API keys:
38+
```
39+
OPENAI_API_KEY = Your_openai_apikey
40+
PPLX_API_KEY = Your_perplexity_apikey
41+
PERPLEXITY_API_KEY = Your_perplexity_apikey
42+
```
43+
4. Run the Flask server:
44+
```
45+
python server.py
46+
```
47+
The server will run on http://localhost:5000.
48+
49+
-----
50+
51+
### Frontend Setup
52+
53+
1. Navigate to the client directory:
54+
```
55+
cd client
56+
```
57+
2. Install dependencies:
58+
```
59+
npm install
60+
```
61+
3. Run the React development server:
62+
```
63+
npm start
64+
```
65+
The client will run on http://localhost:3000.
66+
67+
## Usage
68+
69+
1. Open your browser and go to `http://localhost:3000`.
70+
2. Use the chat interface to describe what you want to learn.
71+
3. Answer the AI's follow-up questions to help it narrow down your specific needs.
72+
4. Once the AI has sufficient information, it will generate your personalized learning roadmap.
73+
74+
-----
75+
76+
## Tech Stack
77+
78+
* **Frontend**: React
79+
* **Backend**: Flask, Python
80+
* **AI Engine**: OpenAI API, Perplexity API

0 commit comments

Comments
 (0)