From 07d59cf01bb0f5a6ad0122d2a20a023fef555316 Mon Sep 17 00:00:00 2001
From: Ishaan Dey <ishaan1013@gmail.com>
Date: Sun, 26 May 2024 11:15:13 -0700
Subject: [PATCH] readme

---
 README.md | 157 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 157 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2888d09
--- /dev/null
+++ b/README.md
@@ -0,0 +1,157 @@
+# Sandbox 📦🪄
+
+Sandbox is an open-source cloud-based code editing environment with custom AI code autocompletion and real-time collaboration.
+
+## Running Locally
+
+### Frontend
+
+Install dependencies
+
+```bash
+cd frontend
+npm install
+```
+
+Add the required environment variables in `.env` (example file provided in `.env.example`)
+
+Then, run in development mode
+
+```bash
+npm run dev
+```
+
+### Backend
+
+The backend consists of a primary Express and Socket.io server, and 3 Cloudflare Workers microservices for the D1 database, R2 storage, and Workers AI. The D1 database also serves as a KV store for user sessions, and it contains a [service binding](https://developers.cloudflare.com/workers/runtime-apis/bindings/service-bindings/) to the R2 storage worker.
+
+#### Socket.io server
+
+Install dependencies
+
+```bash
+cd backend/server
+npm install
+```
+
+Add the required environment variables in `.env` (example file provided in `.env.example`)
+
+Project files will be stored in the `projects/<project-id>` directory. The middleware contains basic authorization logic for connecting to the server.
+
+Run in development mode
+
+```bash
+npm run dev
+```
+
+### Cloudflare Workers (Database, Storage, AI)
+
+Install dependencies
+
+```bash
+cd backend/<database | storage | ai> # do these individually
+npm install
+```
+
+For each, add the required environment variables in `.env` (example file provided in `.env.example`). For the AI worker, you can define any value you want for the `CF_AI_KEY` -- set this in other `.env` files to authorize access.
+
+Run in development mode
+
+```bash
+npm run dev
+```
+
+## Contributing
+
+Thanks for your interest in contributing! Review this section before submitting your first pull request. If you need any help, feel free to reach out to [@ishaandey\_](https://x.com/ishaandey_).
+
+Please prioritize existing issues, but feel free to contribute new issues if you have ideas for a feature or bug that you think would be useful.
+
+### Structure
+
+```
+frontend/
+├── app
+├── assets
+├── components
+└── lib
+backend/
+├── server
+├── database/
+│   ├── src
+│   └── drizzle
+├── storage
+└── ai
+```
+
+| Path               | Description                                                                |
+| ------------------ | -------------------------------------------------------------------------- |
+| `frontend/www/app` | The Next.js application for the frontend.                                  |
+| `backend/server`   | The Express websocket server.                                              |
+| `backend/database` | API for interfacing with the D1 database (SQLite) and KV store.            |
+| `backend/storage`  | API for interfacing with R2 storage. Service-bound to `/backend/database`. |
+| `backend/ai`       | API for making requests to Workers AI .                                    |
+
+### Development
+
+#### Fork this repo
+
+You can fork this repo by clicking the fork button in the top right corner of this page.
+
+#### Clone repository
+
+```bash
+git clone https://github.com/<your-username>/sandbox.git
+cd sandbox
+```
+
+#### Create a new branch
+
+```bash
+git checkout -b my-new-branch
+```
+
+### Commit convention
+
+Before you create a Pull Request, please check that you use the [Conventional Commits format](https://www.conventionalcommits.org/en/v1.0.0/)
+
+It should be in the form `category(scope or module): message` in your commit message from the following categories:
+
+- `feat / feature`: all changes that introduce completely new code or new
+  features
+- `fix`: changes that fix a bug (ideally you will additionally reference an
+  issue if present)
+- `refactor`: any code related change that is not a fix nor a feature
+- `docs`: changing existing or creating new documentation (i.e. README, docs for
+  usage of a lib or cli usage)
+- `chore`: all changes to the repository that do not fit into any of the above
+  categories
+
+  e.g. `feat(editor): improve tab switching speed`
+
+## Tech stack
+
+### Frontend
+
+- [Next.js](https://nextjs.org/)
+- [TailwindCSS](https://tailwindcss.com/)
+- [Shadcn UI](https://ui.shadcn.com/)
+- [Clerk](https://clerk.com/)
+- [Monaco](https://microsoft.github.io/monaco-editor/)
+
+### Backend
+
+- [Cloudflare Workers](https://developers.cloudflare.com/workers/)
+  - [D1 database](https://developers.cloudflare.com/d1/)
+  - [R2 storage](https://developers.cloudflare.com/r2/)
+  - [Workers AI](https://developers.cloudflare.com/workers-ai/)
+  - [Workers KV](https://developers.cloudflare.com/kv/)
+- [Express](https://expressjs.com/)
+- [Socket.io](https://socket.io/)
+- [Drizzle ORM](https://orm.drizzle.team/)
+
+### Infra / Hosting
+
+- [Vercel](https://vercel.com/)
+- [Docker](https://www.docker.com/)
+- [AWS ECS + Fargate](https://aws.amazon.com/ecs/)