Skip to content

Latest commit

 

History

History
97 lines (69 loc) · 2.08 KB

getting-started.md

File metadata and controls

97 lines (69 loc) · 2.08 KB

Getting Started 🏁

  1. Clone the repository:
git clone https://github.com/amosproj/amos2024ss05-knowledge-graph-extractor.git
  1. Change directory into the project:
cd amos2024ss05-knowledge-graph-extractor
  1. Copy the .env.example file to .env and update the values as needed:
cp Project/backend/.env.example Project/backend/.env

Initial Setup ⚙️

Important

Ensure you have Docker and Python 3.11 or higher installed before proceeding with the setup.

Development Prerequisites

  1. Create a virtual environment:
python -m venv venv
  1. Activate the virtual environment:
source venv/bin/activate
  1. Install the development requirements specific to your IDE for enhanced functionality and support:
pip install -r Project/backend/codebase/requirements.txt

Build the image and run the Container:

  • If buildkit is not enabled, enable it and build the image:
DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 docker-compose -f Project/backend/docker-compose.yml up --build -d
  • If buildkit is enabled, build the image:
docker-compose -f Project/backend/docker-compose.yml up --build -d

Start Frontend server:

  1. Navigate to the frontend directory:
cd Project/frontend
  1. Install the frontend dependencies:
npm install
  1. Build the frontend:
npm run dev

Note

Alternatively, you can use the Makefile to run the Container and the frontend server from the Project directory:

  • Start the Container and the Frontend Server:
   make build-dev

Only start the Frontend Server:

make frontend-build-dev

Only start the Container:

make backend-build-dev

For detailed instructions, see the Getting Started Guide.

You can now access the application at [http://localhost:8000](http://localhost:8000. The development environment allows for immediate reflection of code changes.