diff --git a/README.md b/README.md index ba11edc810..da4ab5ab04 100644 --- a/README.md +++ b/README.md @@ -27,23 +27,23 @@ Choose either **stable** or **development**. For **stable** release: -- `pip install gpt-engineer` +- `python -m pip install gpt-engineer` For **development**: - `git clone https://github.com/AntonOsika/gpt-engineer.git` - `cd gpt-engineer` -- `pip install -e .` +- `python -m pip install -e .` - (or: `make install && source venv/bin/activate` for a venv) -**Setup** +**API Key** -With an OpenAI API key (preferably with GPT-4 access) run: +With an OpenAI API key run: - `export OPENAI_API_KEY=[your api key]` -To set API key on windows check the [Windows README](./WINDOWS_README.md). +Check the [Windows README](./WINDOWS_README.md) for windows usage. -**Run**: +**Running** - Create an empty folder. If inside the repo, you can run: - `cp -r projects/example/ projects/my-new-project` @@ -54,38 +54,15 @@ To set API key on windows check the [Windows README](./WINDOWS_README.md). By running gpt-engineer you agree to our [terms](https://github.com/AntonOsika/gpt-engineer/blob/main/TERMS_OF_USE.md). **Results** -- Check the generated files in `projects/my-new-project/workspace` +Check the generated files in `projects/my-new-project/workspace` -To **run in the browser** you can simply: +**Alternatives** -[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/AntonOsika/gpt-engineer/codespaces) - - -## Getting Started using Docker - -**Running using docker cli**: - -Building the image: -- `git clone https://github.com/AntonOsika/gpt-engineer.git` -- `cd gpt-engineer` -- `docker build --rm -t gpt-engineer .` - -Running the container: -- `docker run -it --rm -e OPENAI_API_KEY="YOUR OPENAI KEY" -v ./your-project:/project gpt-engineer` - -The `-v` flag mounts the `your-project` folder into the container. Make sure to have a `prompt` file in there. - -**Running using docker-compose cli**: - -Building the image: -- `git clone https://github.com/AntonOsika/gpt-engineer.git` -- `cd gpt-engineer` -- `docker-compose build` -- `docker-compose run --rm gpt-engineer` - -Set the OPENAI_API_KEY in docker-compose.yml using .env file or environment variable, and mount your project folder into the container using volumes. for example "./projects/example:/project" ./projects/example is the path to your project folder. +You can check [Docker instructions](docker/README.md) to use Docker, or simply +do everything in your browser: +[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/AntonOsika/gpt-engineer/codespaces) ## Features diff --git a/Dockerfile b/docker/Dockerfile similarity index 79% rename from Dockerfile rename to docker/Dockerfile index dd81969641..98ab2c2ee6 100644 --- a/Dockerfile +++ b/docker/Dockerfile @@ -6,6 +6,7 @@ RUN apt-get update \ WORKDIR /app COPY . . +COPY docker/entrypoint.sh ./entrypoint.sh RUN sudo pip install -e . diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 0000000000..0f4d4929f4 --- /dev/null +++ b/docker/README.md @@ -0,0 +1,24 @@ +# Getting Started using Docker + +**Running using docker cli**: + +Building the image: +- `git clone https://github.com/AntonOsika/gpt-engineer.git` +- `cd gpt-engineer` +- `docker build --rm -t gpt-engineer -f docker/Dockerfile .` + +Running the container: +- `docker run -it --rm -e OPENAI_API_KEY="YOUR OPENAI KEY" -v ./your-project:/project gpt-engineer` + +The `-v` flag mounts the `your-project` folder into the container. Make sure to have a `prompt` file in there. + +**Running using docker-compose cli**: + +Building the image: +- `git clone https://github.com/AntonOsika/gpt-engineer.git` +- `cd gpt-engineer` +- `docker-compose build -f docker/docker-compose.yml` +- `docker-compose run --rm gpt-engineer` + + +Set the OPENAI_API_KEY in docker/docker-compose.yml using .env file or environment variable, and mount your project folder into the container using volumes. for example "./projects/example:/project" ./projects/example is the path to your project folder. diff --git a/docker-compose.yml b/docker/docker-compose.yml similarity index 100% rename from docker-compose.yml rename to docker/docker-compose.yml diff --git a/entrypoint.sh b/docker/entrypoint.sh similarity index 100% rename from entrypoint.sh rename to docker/entrypoint.sh