Skip to content

Commit 17f5e95

Browse files
committed
docs: Add readme with required assets
1 parent 00fee36 commit 17f5e95

9 files changed

Lines changed: 62 additions & 0 deletions

File tree

README.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Quicky Admin Churn Prediction Backend
2+
This repository includes the project files related to admin churn prediction backend of Quicky delivery platform.
3+
4+
## Getting Started
5+
To get started with the project, follow these steps:
6+
7+
1. Clone the repository:
8+
```bash
9+
git clone https://github.com/HashiruG/Quicky_Admin_Churn_Prediction.git
10+
```
11+
2. Navigate to the project directory:
12+
```bash
13+
cd Quicky_Admin_Churn_Prediction
14+
```
15+
3. Create a virtual environment:
16+
```bash
17+
python -m venv venv
18+
```
19+
4. Activate the virtual environment:
20+
```bash
21+
.\venv\Scripts\activate
22+
```
23+
5. Install dependencies:
24+
```bash
25+
pip install -r requirements.txt
26+
```
27+
6. Run the server:
28+
```bash
29+
uvicorn app.main:app --reload
30+
```
31+
32+
## Other Repositories associated with this project
33+
1. Quicky admin main backend : [https://github.com/HashiruG/Quicky_Backend](https://github.com/HashiruG/Quicky_Backend)
34+
2. Quicky admin frontend : [https://github.com/HashiruG/Quicky_Frontend](https://github.com/HashiruG/Quicky_Frontend)
35+
36+
## Few Screenshots
37+
<p align="center">
38+
<img src="./assets/sc1.png" alt="App Screenshot" width="80%" height="400" style="margin: 20px 0;" />
39+
</p>
40+
<p align="center">
41+
<img src="./assets/sc2.jpeg" alt="App Screenshot" width="80%" height="400" style="margin: 20px 0;" />
42+
</p>
43+
<p align="center">
44+
<img src="./assets/sc3.jpeg" alt="App Screenshot" width="80%" height="400" style="margin: 20px 0;" />
45+
</p>
46+
<p align="center">
47+
<img src="./assets/sc4.png" alt="App Screenshot" width="80%" height="400" style="margin: 20px 0;" />
48+
</p>
49+
<p align="center">
50+
<img src="./assets/sc5.png" alt="App Screenshot" width="80%" height="400" style="margin: 20px 0;" />
51+
</p>
52+
<p align="center">
53+
<img src="./assets/sc6.png" alt="App Screenshot" width="80%" height="400" style="margin: 20px 0;" />
54+
</p>
55+
<p align="center">
56+
<img src="./assets/sc7.png" alt="App Screenshot" width="80%" height="400" style="margin: 20px 0;" />
57+
</p>
58+
<p align="center">
59+
<img src="./assets/sc8.png" alt="App Screenshot" width="80%" height="400" style="margin: 20px 0;" />
60+
</p>
61+
62+

assets/sc1.png

42.9 KB
Loading

assets/sc2.jpeg

108 KB
Loading

assets/sc3.jpeg

104 KB
Loading

assets/sc4.png

70.3 KB
Loading

assets/sc5.png

141 KB
Loading

assets/sc6.png

117 KB
Loading

assets/sc7.png

66.1 KB
Loading

assets/sc8.png

65.8 KB
Loading

0 commit comments

Comments
 (0)