diff --git a/Dockerfile b/Dockerfile index 24aa307830..8118cf3f81 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,15 +1,15 @@ FROM node:20-alpine +# Set working directory WORKDIR /app -# Copy package files from sim directory -COPY sim/package.json sim/package-lock.json ./ -RUN npm ci - -# Copy sim directory contents +# Copy the entire sim directory COPY sim/ ./ +# Install dependencies +RUN npm install + EXPOSE 3000 # Default to development mode -CMD ["npm", "run", "dev"] \ No newline at end of file +CMD ["npm", "run", "dev"] \ No newline at end of file diff --git a/README.md b/README.md index a1c9a44ae0..b40eae9ae3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +

+ Sim Studio Logo +

+ # Sim Studio [![Discord](https://img.shields.io/badge/Discord-Join%20Server-7289DA?logo=discord&logoColor=white)](https://discord.gg/pQKwMTvNrg) [![Twitter](https://img.shields.io/twitter/follow/simstudio?style=social)](https://x.com/simstudioai) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) @@ -11,7 +15,9 @@ ## How to Self-Host -Fork this repository by clicking the "Fork" button at the top right of this page. +### Step 1: Fork the Repository + +**Important:** Start by forking this repository by clicking the "Fork" button at the top right of this page. This creates your own copy of the repository under your GitHub account. > **Note:** Ensure you have VS Code or another editor, git, npm, and Docker (if you're not setting up manually) installed on your system. @@ -20,7 +26,7 @@ There are several ways to self-host Sim Studio: ### Option 1: Docker Environment (Recommended) ```bash -# Clone the repository +# Clone your forked repository git clone https://github.com/YOUR_USERNAME/sim.git cd sim @@ -29,8 +35,6 @@ cp sim/.env.example sim/.env # Start the Docker environment docker compose up -d -# Or use the helper script -./scripts/start_simstudio_docker.sh ``` After running these commands: diff --git a/sim/public/sim.png b/sim/public/sim.png new file mode 100644 index 0000000000..acf43ad85b Binary files /dev/null and b/sim/public/sim.png differ