README.md

Build the docker image

Prerequisites

Before you begin, deactivate your virtual environment if any and ensure you have met the following requirements: Before you begin, deactivate your virtual environment if any and ensure you have met the following requirements:

• Git

• Python

• NPM

• Docker Desktop

• Python

• NPM

• Docker Desktop

  • Install Docker Desktop on Mac
  • Install Docker Desktop on Windows
  • Install Docker Desktop on Linux

  • Make sure the following command doesn't return an error:

    docker image ls

• Task

  • Install task

    sudo sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b /usr/local/bin

  • Make sure the following command doesn't return an error

    which task

Installation

To set up the project, follow these steps:

1. Clone the repository:

   git clone git@github.com:linalgo/wsd.git
   cd wsd

2. Copy environment variables and update as needed:

   cp .env.example .env

3. Install pre-commit:

   If pre-commit is not already installed, you can install it using the following command:

    pip install pre-commit
    pre-commit install

4. Build docker image:

   task build

5. Access the Docker Container:

   docker compose up dev -d
   docker exec -it wsd-dev bash