Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docker setup for development environment #2885

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

# Contributing to the Project

We welcome contributions in the form of bug reports, feature requests,
Expand Down Expand Up @@ -130,6 +129,24 @@ The project includes a `Dockerfile` for building a Docker image. You can build t
docker build -t aider -f docker/Dockerfile .
```

### Setting up the Development Environment using Docker

To set up the development environment using Docker, follow these steps:

1. Ensure you have Docker and Docker Compose installed on your machine.
2. Clone the repository:
```bash
git clone https://github.com/Aider-AI/aider.git
cd aider
```
3. Build and run the Docker container using `docker-compose`:
```bash
docker-compose up --build
```
4. The development environment will be set up inside the Docker container, and you can start working on the project.

The `docker-compose.yml` file defines the service for the development environment, using the `Dockerfile` located in the `benchmark` directory. It mounts the current directory to `/aider` inside the container and sets the working directory to `/aider`. Port 8000 is exposed for potential web server usage.

### Building the Documentation

The project's documentation is built using Jekyll and hosted on GitHub Pages. To build the documentation locally, follow these steps:
Expand Down
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

<!-- Edit README.md, not index.md -->

# Aider is AI pair programming in your terminal
Expand Down Expand Up @@ -66,6 +65,24 @@ and
[usage documentation](https://aider.chat/docs/usage.html)
for more details.

## Setting up the development environment using Docker

To set up the development environment using Docker, follow these steps:

1. Ensure you have Docker and Docker Compose installed on your machine.
2. Clone the repository:
```bash
git clone https://github.com/Aider-AI/aider.git
cd aider
```
3. Build and run the Docker container using `docker-compose`:
```bash
docker-compose up --build
```
4. The development environment will be set up inside the Docker container, and you can start working on the project.

The `docker-compose.yml` file defines the service for the development environment, using the `Dockerfile` located in the `benchmark` directory. It mounts the current directory to `/aider` inside the container and sets the working directory to `/aider`. Port 8000 is exposed for potential web server usage.

## Features

- Run aider with the files you want to edit: `aider <file1> <file2> ...`
Expand Down
12 changes: 12 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
version: '3.8'

services:
aider-dev:
build:
context: .
dockerfile: benchmark/Dockerfile
volumes:
- .:/aider
working_dir: /aider
ports:
- "8000:8000"