Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/3emseybey/leadscraper
https://github.com/3emseybey/leadscraper
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/3emseybey/leadscraper
- Owner: 3emSeyBey
- Created: 2024-10-29T18:28:18.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-07T14:14:31.000Z (about 2 months ago)
- Last Synced: 2024-11-07T15:26:00.491Z (about 2 months ago)
- Language: Python
- Size: 45.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
### What You’ll Need
1. **XAMPP**: A tool that helps run a web server and a database on your computer.
2. **Python**: A programming language that runs the FastAPI project.
3. **Git**: A tool to download the project from GitHub.
### Step-by-Step Instructions
#### Step 1: Install XAMPP
1. **Download XAMPP**:
- Go to the [XAMPP website](https://www.apachefriends.org/index.html) and download the version for your operating system (Windows, macOS, or Linux).
2. **Install XAMPP**:
- Open the downloaded file and follow the instructions to install it.
3. **Start XAMPP**:
- Open the **XAMPP Control Panel** (it should be available in your start menu or applications).
- Click **Start** next to **Apache** and **MySQL** to run these services.
#### Step 2: Install Python
1. **Download Python**:
- Visit the [Python website](https://www.python.org/downloads/) and download the latest version.
2. **Install Python**:
- Run the installer and make sure to check the box that says “Add Python to PATH” before clicking **Install Now**.
#### Step 3: Install Git
1. **Download Git**:
- Go to the [Git website](https://git-scm.com/downloads) and download the version for your operating system.
2. **Install Git**:
- Follow the instructions to install it on your computer.
#### Step 4: Download the FastAPI Project
1. **Open the Terminal**:
- On Windows, search for "Command Prompt" or "PowerShell".
- On macOS, open "Terminal" from your Applications.
2. **Navigate to Your Folder**:
- Use the `cd` command to change to the folder where you want to download the project. For example:
```bash
cd C:\path\to\your\folder
```
- Replace `C:\path\to\your\folder` with your desired folder path.
3. **Clone the Project**:
- Copy the link of the GitHub repository (it should look like `https://github.com/username/repository-name.git`).
- In the terminal, type the following command and paste the link:
```bash
git clone https://github.com/username/repository-name.git
```
- Press **Enter**. This will download the project files to your folder.
#### Step 5: Set Up the Database
1. **Open phpMyAdmin**:
- In your web browser, go to `http://localhost/phpmyadmin`.
2. **Create a New Database**:
- Click on the **Databases** tab at the top.
- Enter a name for your database (e.g., `fastapi_db`) and click **Create**.
#### Step 6: Configure the Project
1. **Open the Project Folder**:
- Find the folder where you cloned the GitHub project and open it.
2. **Locate the Configuration File**:
- Look for a file that might be named something like `config.py` or `settings.py`.
3. **Update Database Connection**:
- Find the line that mentions `DATABASE_URL` and change it to:
```python
DATABASE_URL = "mysql+pymysql://root:@localhost/fastapi_db"
```
- This tells the project to connect to the database you just created. (`root` is the default username; leave the password blank).
#### Step 7: Run the FastAPI Application
1. **Open the Terminal Again**:
- Make sure you’re still in the project folder.
2. **Run the Application**:
- Type the following command to start the application:
```bash
uvicorn main:app --reload
```
- Press **Enter**. This will start the FastAPI server.
#### Step 8: Access the Application
1. **Open Your Web Browser**:
- Go to `http://127.0.0.1:8000` to see your FastAPI application running.
- You can also check the interactive API documentation by visiting `http://127.0.0.1:8000/docs`.
### Additional Tips
- **Stopping the Server**: If you want to stop the server, go back to the terminal where it’s running and press `Ctrl + C`.
- **Troubleshooting**: If you see any error messages, double-check that Apache and MySQL are running in the XAMPP Control Panel and that you entered the correct database settings.
### Conclusion
You now have a FastAPI project set up and running with XAMPP! Feel free to explore the project files and learn more about how it works. If you have any questions, don’t hesitate to ask for help!