|
2 | 2 |
|
3 | 3 | A community-driven port of Microsoft's [CodePush Standalone](https://github.com/microsoft/code-push-server), designed for cost-effective and scalable over-the-air updates using Cloudflare Workers.
|
4 | 4 |
|
| 5 | +**No Servers Needed!** You can now use CodePush Standalone without managing any infrastructure, **nor needing an understanding of it!** |
| 6 | + |
5 | 7 | **Status: Alpha 🧪** - Core functionality is **100% compatible ✅** with the official CodePush, but further testing and improvements are ongoing.
|
6 | 8 |
|
7 | 9 | **Important Note:** This project is not affiliated with, maintained, or endorsed by Microsoft or the CodePush team. It's a community initiative aimed at providing a more accessible and affordable alternative.
|
@@ -32,6 +34,52 @@ This project provides **a seamless, drop-in replacement 🔌** using Cloudflare
|
32 | 34 | - 🌐 **Edge Delivery**: Utilizes Cloudflare's edge network for fast updates.
|
33 | 35 | - ⚡️ **Seamless Deployment:** Deploy your CodePush server to Cloudflare Workers with a streamlined and simplified process, reducing the setup time and effort
|
34 | 36 |
|
| 37 | +## Getting Started |
| 38 | + |
| 39 | +**Base Guide:** |
| 40 | + - `apps/server`: CodePush Standalone Server (Cloudflare Workers) |
| 41 | + - `apps/web`: Admin UI for managing apps, deployments, and releases (optional, Cloudflare Pages) |
| 42 | + |
| 43 | +**Note:** Detailed instructions and commands for each step are **TBD** and will be added soon. Here's a high-level overview: |
| 44 | + |
| 45 | +1. **Clone the Repository:** |
| 46 | + ```bash |
| 47 | + git clone https://github.com/your-repo/code-push-cloudflare-workers.git |
| 48 | + cd code-push-cloudflare-workers |
| 49 | + ``` |
| 50 | +2. **Install Dependencies:** |
| 51 | + ```bash |
| 52 | + corepack enable |
| 53 | + pnpm install |
| 54 | + ``` |
| 55 | +3. **Configure Cloudflare:** |
| 56 | + - Install the `wrangler` CLI. |
| 57 | + - Authenticate with your Cloudflare account. |
| 58 | + - Create a D1 database and an R2 bucket. |
| 59 | + - Update `wrangler.toml` with your Cloudflare credentials and other environment variables in the `apps/server` directory. |
| 60 | +4. **Apply Database Migrations:** |
| 61 | + |
| 62 | + ```bash |
| 63 | + cd apps/server |
| 64 | + pnpm apply |
| 65 | + ``` |
| 66 | + or for production enviroment |
| 67 | + ```bash |
| 68 | + pnpm apply:production |
| 69 | + ``` |
| 70 | + |
| 71 | +5. **Deploy the Backend:** |
| 72 | + ```bash |
| 73 | + cd apps/server |
| 74 | + pnpm wrangler publish |
| 75 | + ``` |
| 76 | +6. **Run the Admin UI:** |
| 77 | + ```bash |
| 78 | + cd apps/web |
| 79 | + pnpm dev |
| 80 | + ``` |
| 81 | + |
| 82 | + |
35 | 83 | ## License
|
36 | 84 |
|
37 | 85 | Licensed under the **Apache License 2.0**. See [LICENSE](LICENSE) for details.
|
0 commit comments