Welcome to the "Ingint" backend repository. This readme file will guide you through the installation steps to set up and run the project on your local machine.
Before you begin, ensure you have the following installed:
- Python (3.9 or higher)
- pip (Python package manager)
-
Clone the repository to your local machine:
git clone https://github.com/oyeadii/ingintBackend.git
-
Change your working directory to the project folder:
cd ingintBackend
-
Create a virtual environment (recommended) to isolate project dependencies:
python3 -m venv venv
-
Activate the virtual environment (on Windows):
venv\Scripts\activate
- On macOS and Linux:
source venv/bin/activate
-
Install project dependencies using pip:
pip install -r requirements.txt
-
Copy the .env.example file and rename it to .env. Edit the .env file and add the necessary environment variables specific to your project.
-
Migrate the database:
- Import the SQL dump present in db_dump folder to a MySQL database.
-
Create a superuser account to access the Django admin interface (follow the prompts):
- Run below SQL command in your SQL viewer.
INSERT INTO admin (email, password) VALUES ('<your email id here>', '$2b$12$vcxVVabhPRSqNLbL2M.noOMYdSXOZ3qzM0YSDTnKOFbdrDsDpNy8W');
- Change your email in above command. Above password defaults to 'qwerty@1234'
-
Running the Project
- Now that you have installed the project and set up your environment, you can run the Django development server:
python manage.py runserver
- The development server will start, and you can access the project at http://localhost:8000/.
- This repo also includes code forked from https://github.com/run-llama/llama_index.git in folder named custom_llama_index.
- This was done to have version control and also to add some custom configuration at the point of file upsert to pinecone.