Skip to content

Commit 41f451e

Browse files
committed
changed READMEs for all projects to include 1 click deploy
1 parent 2378ba8 commit 41f451e

File tree

51 files changed

+108
-68
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+108
-68
lines changed

samples/angular-express/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Angular & Node.js
22

3+
[1-click deploy](https://github.com/new?template_name=sample-angular-express-template&template_owner=DefangSamples)
4+
35
This project demonstrates both client-side component rendering and hydration with Angular, as well as server-side rendering with Node.js and Socket.IO for real-time communication. It also includes Docker configurations for easy deployment.
46

57
## NOTE
@@ -25,13 +27,6 @@ This sample showcases how you could deploy a full-stack application with Angular
2527
2. Type `defang compose up` in the CLI
2628
3. Your app should be up and running with Defang in minutes!
2729

28-
## One click deployment
29-
30-
1. Open the main [Defang](https://defang.io/) page
31-
2. Navigate to the samples section and search `Angular & Node.js`
32-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
33-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
34-
3530
## Development
3631

3732
For development, we use two local containers, one for the frontend Angular service and one for the backend service in Express. It also uses Caddy as a web server for serving static files. To run the sample locally after cloning the repository, you can run on Docker by doing:

samples/bullmq-bullboard-redis/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# BullMQ & BullBoard & Redis
22

3+
[1-click deploy](https://github.com/new?template_name=sample-bullmq-bullboard-redis-template&template_owner=DefangSamples)
4+
35
This sample project demonstrates how to deploy a BullMQ message queue on top of managed Redis with a queue processor and a dashboard to monitor the queue.
46

57
Once your app is up and running you can go to the `/board` route for the `board` service to see the Bull Board dashboard and use the username `admin` and the password you set to log in (see [Deploying](#deploying)).
@@ -20,13 +22,6 @@ The `worker` service is the queue processor that will process the jobs added to
2022
3. Type `defang compose up` in the CLI.
2123
4. Your app will be running within a few minutes.
2224

23-
## One click deployment
24-
25-
1. Open the main [Defang](https://defang.io/) page
26-
2. Navigate to the samples section and search `BullMQ & BullBoard & Redis`
27-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
28-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
29-
3025
## Local Development
3126

3227
1. Run `docker compose -f compose.dev.yaml up`

samples/csharp-dotnet/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# ASP.NET Core & JavaScript Task Manager
22

3+
[1-click deploy](https://github.com/new?template_name=sample-csharp-dotnet-template&template_owner=DefangSamples)
4+
35
This project is a simple task manager application using ASP.NET Core for the backend and JavaScript for client-side component rendering. We show case how to deploy it to both defang and docker for both prod and dev environments.
46

57
## NOTE
@@ -24,13 +26,6 @@ This sample showcases how you could deploy a full-stack application with ASP.NET
2426
2. Type `defang compose up` in the CLI
2527
3. Your app should be up and running with Defang in minutes!
2628

27-
## One click deployment
28-
29-
1. Open the main [Defang](https://defang.io/) page
30-
2. Navigate to the samples section and search `ASP.NET`
31-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
32-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
33-
3429
## Development
3530

3631
For development, we use two local containers, one for the frontend service and one for the backend service in ASP.NET Core. It also uses Caddy as a web server for serving static files. To run the sample locally after cloning the repository, you can run on Docker by doing:

samples/django-postgres/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Django & Postgres
22

3+
[1-click deploy](https://github.com/new?template_name=sample-django-postgres-template&template_owner=DefangSamples)
4+
35
This template is a customer relationship management list project developed using Python Django framework, offering a starting point to help you quickly build your customer management system. We use PostgreSQL as the database. We have prepared all the essential files for deployment. By spending less than 10 minutes setting up the environment, as detailed in the prerequisites, and executing the commands in our step-by-step guide, your website will be ready to go live to the world!
46

57
## NOTE
@@ -24,13 +26,6 @@ This sample showcases how you could deploy a full-stack application with Defang
2426
2. Type `defang compose up` in the CLI
2527
3. Now your application will be launched
2628

27-
## One click deployment
28-
29-
1. Open the main [Defang](https://defang.io/) page
30-
2. Navigate to the samples section and search `Django & Postgres`
31-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
32-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
33-
3429
---
3530

3631
Title: Django & PostgreSQL

samples/django/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Django
22

3+
[1-click deploy](https://github.com/new?template_name=sample-django-template&template_owner=DefangSamples)
4+
35
This is a simple example of how to run Django on Defang. It is a simple Todo app that uses SQLite as the database.
46

57
### NOTE
@@ -29,13 +31,6 @@ The Dockerfile and compose files are already set up for you and are ready to be
2931
3. Type `defang compose up` in the CLI
3032
4. Now your application will be launched
3133

32-
## One click deployment
33-
34-
1. Open the main [Defang](https://defang.io/) page
35-
2. Navigate to the samples section and search `Django`
36-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
37-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
38-
3934
---
4035

4136
Title: Django

samples/elysia/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Elysia & Bun
22

3+
[1-click deploy](https://github.com/new?template_name=sample-elysia-template&template_owner=DefangSamples)
4+
35
A basic [Elysia](https://elysiajs.com/) app running on [Bun](https://bun.sh/) with a Dockerfile and compose.yaml ready to deploy to AWS with [Defang](https://defang.io).
46

57
## Prerequisites
@@ -14,13 +16,6 @@ A basic [Elysia](https://elysiajs.com/) app running on [Bun](https://bun.sh/) wi
1416
2. Run `defang compose up`.
1517
3. Your app will be running within a few minutes.
1618

17-
## One click deployment
18-
19-
1. Open the main [Defang](https://defang.io/) page
20-
2. Navigate to the samples section and search `Elysia`
21-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
22-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
23-
2419
## Local Development
2520

2621
1. Run `docker compose -f compose.dev.yaml up`

samples/fastapi-postgres/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# FastAPI & PostgreSQL
22

3+
[1-click deploy](https://github.com/new?template_name=sample-fastapi-postgres-template&template_owner=DefangSamples)
4+
35
This sample project demonstrates how to deploy FastAPI with PostgreSQL with Defang.
46

57
## Prerequisites
@@ -13,13 +15,6 @@ This sample project demonstrates how to deploy FastAPI with PostgreSQL with Defa
1315
2. Type `defang compose up` in the CLI.
1416
3. Your app will be running within a few minutes.
1517

16-
## One click deployment
17-
18-
1. Open the main [Defang](https://defang.io/) page
19-
2. Navigate to the samples section and search `FastAPI & PostgreSQL`
20-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
21-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
22-
2318
## Local Development
2419

2520
1. Run `docker compose -f compose.dev.yaml up`

samples/fastapi/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# FastAPI
22

3+
[1-click deploy](https://github.com/new?template_name=sample-fastapi-template&template_owner=DefangSamples)
4+
35
This sample project demonstrates how to deploy FastAPI with Defang.
46

57
## Prerequisites
@@ -13,13 +15,6 @@ This sample project demonstrates how to deploy FastAPI with Defang.
1315
2. Type `defang compose up` in the CLI.
1416
3. Your app will be running within a few minutes.
1517

16-
## One click deployment
17-
18-
1. Open the main [Defang](https://defang.io/) page
19-
2. Navigate to the samples section and search `FastAPI`
20-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
21-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
22-
2318
## Development
2419

2520
To run your FastAPI app locally, you'll need to have Docker installed on your machine. You can then run:

samples/feathersjs/README.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This sample project demonstrates how to deploy a FeathersJS application on to AWS using Defang. We also demonstrate how to run the application in both development and production environments using Docker Compose.
44

5+
[1-click deploy](https://github.com/new?template_name=sample-feathersjs-template&template_owner=DefangSamples)
6+
57
## Prerequisites
68

79
1. Download [Defang CLI](https://github.com/DefangLabs/defang) (for Defang deployment)
@@ -24,13 +26,6 @@ docker compose -f compose.dev.yaml up --build
2426
2. Type `defang compose up` in the CLI.
2527
3. Your app will be running within a few minutes.
2628

27-
## One click deployment
28-
29-
1. Open the main [Defang](https://defang.io/) page
30-
2. Navigate to the samples section and search `FeathersJS`
31-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
32-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
33-
3429
---
3530

3631
Title: Feathers.js

samples/flask/README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Flask
22

3+
[1-click deploy](https://github.com/new?template_name=sample-flask-template&template_owner=DefangSamples)
4+
35
This is a sample of a basic Flask TODO app. The items are stored in memory and are lost when the server is restarted, but it should give you a basic idea of how to get started with Flask on Defang. Note that alognside your .py file, include a requirements.txt so that the Dockerfile can install the necessary packages with pip.
46

57
### NOTE:
@@ -25,11 +27,6 @@ This sample is a simple Flask app that demonstrates how to create a TODO app usi
2527

2628
## One click deployment
2729

28-
1. Open the main [Defang](https://defang.io/) page
29-
2. Navigate to the samples section and search `flask`
30-
3. Click the one-click deploy option. This will prompt you to create a repository and run a github action to deploy this project.
31-
4. To monitor your services' status in the defang portal, check out the Deploy step for the URL to the portal.
32-
3330
---
3431

3532
Title: Flask

0 commit comments

Comments
 (0)