Prepare Environment

Prerequisite#

Install Docker and Docker Compose on your computer.

Fork Project#

Go to Spider repository and fork it.

Clone the project from GitHub:

git clone git@github.com:YOUR_USERNAME/FORKED_REPO.git

Create a new branch:

# Structure
git checkout -b add-toolname-tool

# Example
git checkout -b add-nmap-tool

Open the project in your IDE. Now run the project.

Run Project#

The project is developed with Django. You can run the project using Docker or by creating a Python virtual environment.

If you are using Windows, we recommend using Docker.

Docker#

Run this command:

docker compose up -d

Project URL: http://localhost:8001

Terminal PTY Server: http://localhost:8282

Python VEnv#

Install Python and set up Virtual Environment.

Install requirements:

pip install -r requirements.txt

Now run:

python manage.py runserver

Project URL: http://localhost:8000