Skip to content

Commit 9383aaa

Browse files
Update README.md
1 parent cb959b3 commit 9383aaa

File tree

1 file changed

+123
-1
lines changed

1 file changed

+123
-1
lines changed

README.md

Lines changed: 123 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,123 @@
1-
# sqldatabase
1+
# SQLDatabase Termux Program
2+
3+
This is a **SQL Database program** designed to run in **Termux** on Android devices. The program allows you to interact with SQL databases directly from your phone using Python. It features a simple, interactive command-line interface (CLI) to practice SQL queries, take quizzes, and track your progress.
4+
5+
### **Advantages**:
6+
- **Lightweight and Mobile**: Run SQL databases directly on your mobile device via Termux.
7+
- **Interactive CLI**: Practice and learn SQL commands interactively.
8+
- **SQL Quiz Mode**: Test your knowledge with an interactive quiz.
9+
- **Progress Tracking**: Track your learning progress with visual graphs.
10+
- **Developer-friendly**: Modify or extend the functionality as needed.
11+
12+
---
13+
14+
## **Requirements**
15+
16+
To run this program on your Android device, you'll need to install **Termux**, set up the environment, and install Python along with the necessary dependencies.
17+
18+
### **1. Install Termux**
19+
20+
- **Install Termux from the Google Play Store or F-Droid**:
21+
- [Download Termux from Google Play Store](https://play.google.com/store/apps/details?id=com.termux)
22+
- [Download Termux from F-Droid](https://f-droid.org/packages/com.termux/)
23+
24+
Once installed, open Termux to start the setup.
25+
26+
### **2. Set Up the Termux Environment**
27+
28+
#### **Update Termux Packages**
29+
First, update the Termux package repository to ensure you have the latest version of all packages:
30+
31+
```bash
32+
pkg update
33+
pkg upgrade
34+
```
35+
36+
#### **Install Dependencies**
37+
38+
To run the program, you need to install Python and a few required libraries. Execute the following commands:
39+
40+
```bash
41+
pkg install python
42+
pkg install git
43+
pkg install clang
44+
pkg install libffi-dev
45+
pkg install libssl-dev
46+
pkg install build-essential
47+
```
48+
49+
These packages will set up the Python environment and essential tools for compiling any dependencies.
50+
51+
### **3. Install Python**
52+
53+
Python should already be installed when you run `pkg install python`. However, you can check the Python version with:
54+
55+
```bash
56+
python --version
57+
```
58+
59+
It should show a Python 3 version (e.g., `Python 3.x.x`).
60+
61+
### **4. Clone the Repository**
62+
63+
Next, clone the **SQLDatabase** repository from GitHub:
64+
65+
```bash
66+
git clone https://github.com/mishra9759harshit/sqldatabase.git
67+
```
68+
69+
This command will create a folder named `sqldatabase` in your Termux home directory.
70+
71+
### **5. Navigate to the Project Directory**
72+
73+
Move to the `sqldatabase` directory:
74+
75+
```bash
76+
cd sqldatabase
77+
```
78+
79+
### **6. Install Python Dependencies**
80+
81+
Install the required Python libraries listed in the `requirements.txt` file. If no `requirements.txt` exists, manually install the necessary packages:
82+
83+
```bash
84+
pip install sqlite3
85+
pip install rich
86+
pip install matplotlib
87+
```
88+
89+
These dependencies are used for the program's SQL functionality, the interactive CLI, and visualizations.
90+
91+
### **7. Run the Program**
92+
93+
Now that everything is set up, you can run the program using:
94+
95+
```bash
96+
python run.py
97+
```
98+
99+
This will launch the interactive SQL database program where you can practice queries, take quizzes, and track your progress.
100+
101+
---
102+
103+
## **Developer Information**
104+
105+
- **Developer**: Harshit Mishra
106+
- **Project Repository**: [https://github.com/mishra9759harshit/sqldatabase.git](https://github.com/mishra9759harshit/sqldatabase.git)
107+
- **License**: MIT License (feel free to contribute or use the code with attribution)
108+
109+
### **Contact Information**:
110+
- **Email**: [mishra9759harshit@gmail.com](mailto:mishra9759harshit@gmail.com)
111+
112+
---
113+
114+
## **Additional Notes**
115+
116+
- The program is designed to run on **Termux**, but you can adapt it for other environments with minor modifications.
117+
- **Future Features**: Support for more databases, advanced query handling, and more interactive modes.
118+
- **Feedback**: If you encounter issues or have suggestions, feel free to open an issue on the GitHub repository.
119+
120+
---
121+
122+
Thank you for using the **SQLDatabase Termux Program**! We hope it helps you practice and learn SQL directly on your mobile device.
123+
```

0 commit comments

Comments
 (0)