Skip to content

Commit 9fd913b

Browse files
jonalvarezzjonalvarezz
committed
add fly deploy
Signed-off-by: Jonathan Alvarez <[email protected]>
1 parent 5315b22 commit 9fd913b

10 files changed

+440
-1
lines changed

‎.dockerignore

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.*
7+
.yarn/*
8+
!.yarn/patches
9+
!.yarn/plugins
10+
!.yarn/releases
11+
!.yarn/versions
12+
13+
# testing
14+
/coverage
15+
16+
# next.js
17+
/.next/
18+
/out/
19+
20+
# production
21+
/build
22+
23+
# misc
24+
.DS_Store
25+
*.pem
26+
27+
# debug
28+
npm-debug.log*
29+
yarn-debug.log*
30+
yarn-error.log*
31+
32+
# env files (can opt-in for committing if needed)
33+
.env*
34+
35+
# vercel
36+
.vercel
37+
38+
# typescript
39+
*.tsbuildinfo
40+
next-env.d.ts
41+
42+
# Sentry Config File
43+
.env.sentry-build-plugin

‎.github/workflows/fly-deploy.yml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# See https://fly.io/docs/app-guides/continuous-deployment-with-github-actions/
2+
3+
name: Fly Deploy
4+
on:
5+
push:
6+
branches:
7+
- main
8+
jobs:
9+
deploy:
10+
name: Deploy app
11+
runs-on: ubuntu-latest
12+
concurrency: deploy-group # optional: ensure only one action runs at a time
13+
steps:
14+
- uses: actions/checkout@v4
15+
- uses: superfly/flyctl-actions/setup-flyctl@master
16+
- run: flyctl deploy --remote-only
17+
env:
18+
FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
19+
POSTGRESQL_ENDPOINT: ${{ POSTGRESQL_ENDPOINT }}
20+
SESSION_SECRET: ${{ SESSION_SECRET }}
21+
LAUNCHDARKLY_SDK_KEY: ${{ LAUNCHDARKLY_SDK_KEY }}
22+
SENTRY_DSN: ${{ SENTRY_DSN }}

‎Dockerfile

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# syntax = docker/dockerfile:1
2+
3+
# Adjust NODE_VERSION as desired
4+
ARG NODE_VERSION=20.12.2
5+
FROM node:${NODE_VERSION}-slim as base
6+
7+
LABEL fly_launch_runtime="Next.js"
8+
9+
# Next.js app lives here
10+
WORKDIR /app
11+
12+
# Set production environment
13+
ENV NODE_ENV="production"
14+
15+
ARG POSTGRESQL_ENDPOINT=""
16+
ARG SESSION_SECRET=""
17+
ARG LAUNCHDARKLY_SDK_KEY=""
18+
ARG SENTRY_DSN=""
19+
20+
ENV POSTGRESQL_ENDPOINT=${POSTGRESQL_ENDPOINT}
21+
ENV SESSION_SECRET=${SESSION_SECRET}
22+
ENV LAUNCHDARKLY_SDK_KEY=${LAUNCHDARKLY_SDK_KEY}
23+
ENV SENTRY_DSN=${SENTRY_DSN}
24+
25+
26+
# Install pnpm
27+
ARG PNPM_VERSION=9.14.4
28+
RUN npm install -g pnpm@$PNPM_VERSION
29+
30+
31+
# Throw-away build stage to reduce size of final image
32+
FROM base as build
33+
34+
# Install packages needed to build node modules
35+
RUN apt-get update -qq && \
36+
apt-get install --no-install-recommends -y build-essential node-gyp pkg-config python-is-python3
37+
38+
# Install node modules
39+
COPY package.json pnpm-lock.yaml ./
40+
RUN pnpm install --frozen-lockfile --prod=false
41+
42+
# Copy application code
43+
COPY . .
44+
45+
# Build application
46+
RUN pnpm run build
47+
48+
# Remove development dependencies
49+
RUN pnpm prune --prod
50+
51+
52+
# Final stage for app image
53+
FROM base
54+
55+
# Copy built application
56+
COPY --from=build /app /app
57+
58+
# Start the server by default, this can be overwritten at runtime
59+
EXPOSE 3000
60+
CMD [ "pnpm", "run", "start" ]

‎README.FLY_DEPLOY.md

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Deploy en Fly.io
2+
3+
Esta página detalla puntos que se deben de tener en cuenta para desplegar una aplicación de Next.js con PostreSQL utilizando [Fly.io](https://fly.io)
4+
5+
1. Crear tu cuenta en Fly.io
6+
7+
Necesitarás agregar una tarjeta de crédito para esto. Te recomendamos activar las opciones de 2FA y utilizar contraseñas fuertes.
8+
9+
2. Creación de maquinas y bases de datos.
10+
11+
Desde la raíz del proyecto y luego de [instalar `flyctl`](https://fly.io/docs/flyctl/install/):
12+
13+
```bash
14+
fly launch
15+
```
16+
17+
Fly detectará que se trata de un proyecto de Next.js y dará una opción para configurar las opciones del proyecto.
18+
19+
En las opciones, debemos especificar que queremos una Base de Datos de tipo PostgreSQL.
20+
21+
Fly creará la base de datos y la adjuntará a nuestra app. Así mismo creará un archivo de `Dockerfile` y de `fly.toml`.
22+
23+
Debido a que nuestro proyecto depende de otros secretos (ver `env.example`), `fly launch` fallará pero nos servirá como base para continuar.
24+
25+
3. Base de datos pública
26+
27+
La base de datos que se crea por defecto es privada. Debido que utilizaremos esta misma base de datos para otros servicios (Clase de Despliegue en Cloudflare), la haremos pública.
28+
29+
Completa la guia de Fly.io de [External Connections](https://fly.io/docs/postgres/connecting/connecting-external/)
30+
31+
Es importante resaltar que la IP a asignar debe de ser de tipo IPV4 y dedicada. Esta IP tendrá un costo de 2 USD/ mensual.
32+
33+
El archivo de configuración de la DB, se guardó en este proyecto dentro de la carpeta [`fly-db`](./fly-db)
34+
35+
Aségurate de que este archivo tenga la siguiente sección:
36+
37+
```toml
38+
[http_service]
39+
internal_port = 5432
40+
force_https = true
41+
auto_stop_machines = 'stop'
42+
auto_start_machines = true
43+
min_machines_running = 0
44+
processes = ['app']
45+
```
46+
47+
Esto evitará el error de configuración de:
48+
49+
> WARNING The app is not listening on the expected address and will not be reachable by fly-proxy.
50+
> You can fix this by configuring your app to listen on the following addresses:
51+
>
52+
> - 0.0.0.0:3000
53+
54+
Aplica los cambios haciendo deploy como se indica en el articulo.
55+
56+
La base de datos debería ahora ser accesible de la forma:
57+
58+
```
59+
psql "postgres://postgres:<password>@<nombre-db-app>.fly.dev"
60+
```
61+
62+
4. Preparar la DB
63+
64+
Accede a la base de datos utilizando la URL de arriba o creando un proxy local para crear las bases de datos y tablas según sea necesario:
65+
66+
- La mini app de `expenses` requiere DB y tabla. Ver `app/expenses-tracker/README.md`
67+
- La mini app de `bookmarks` requiere que corras el comando de `pnpm bookmarks:db:push` y alternativamente `pnpm bookmarks:db:populate`. Asegúrate que la configuración en `drizzle.config.ts` sea correcta.
68+
69+
5. Configurar secretos
70+
71+
Los secretos de nuestra app (`env.example`) debemos configurarlos en dos partes.
72+
73+
La primera en el Dashboard de Fly.io. Y la segunda dentro de Docker.
74+
75+
La diferencia es que los secretos dentro Fly.io son usados durante tiempo de ejecución de la app (runtime). Sin embargo, Docker y nuestro build también los necesita, por tanto debemos especificarlos también.
76+
77+
Estos se secretos se pueden pasar con [`fly deploy --build-secrets`](https://fly.io/docs/apps/build-secrets/#main-content-start). O, recomendado, proveer a través de GitHub Actions a Docker.
78+
79+
En nuestro repo se ha dejado como referencia lo segundo. Ver `Dockerfile` y `.github/workflows/fly-deploy.yml`
80+
81+
6. Deploy
82+
83+
Solo resta hacer deploy de la app
84+
85+
```bash
86+
fly deploy
87+
```
88+
89+
Si todo sale bien, la app estará disponible en Fly.io

‎app/bookmarks/page.tsx

-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ export default function Bookmarks() {
1212

1313
useEffect(() => {
1414
fetch("/bookmarks/api", {
15-
cache: "force-cache",
1615
next: { tags: ["bookmarks"] },
1716
})
1817
.then((response) => response.json() as Promise<{ data: BookmarkType[] }>)

‎fly-db/fly.toml

+77
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# fly.toml app configuration file generated for postgres-platzi-next-15 on 2024-12-12T01:54:25-05:00
2+
#
3+
# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
4+
#
5+
6+
app = 'postgres-platzi-next-15'
7+
primary_region = 'bog'
8+
9+
[env]
10+
PRIMARY_REGION = 'bog'
11+
12+
[[mounts]]
13+
source = 'pg_data'
14+
destination = '/data'
15+
16+
[[services]]
17+
protocol = 'tcp'
18+
internal_port = 5432
19+
auto_start_machines = true
20+
21+
[[services.ports]]
22+
port = 5432
23+
handlers = ['pg_tls']
24+
25+
[services.concurrency]
26+
type = 'connections'
27+
hard_limit = 1000
28+
soft_limit = 1000
29+
30+
[[services]]
31+
protocol = 'tcp'
32+
internal_port = 5433
33+
auto_start_machines = true
34+
35+
[[services.ports]]
36+
port = 5433
37+
handlers = ['pg_tls']
38+
39+
[services.concurrency]
40+
type = 'connections'
41+
hard_limit = 1000
42+
soft_limit = 1000
43+
44+
[checks]
45+
[checks.pg]
46+
port = 5500
47+
type = 'http'
48+
interval = '15s'
49+
timeout = '10s'
50+
path = '/flycheck/pg'
51+
52+
[checks.role]
53+
port = 5500
54+
type = 'http'
55+
interval = '15s'
56+
timeout = '10s'
57+
path = '/flycheck/role'
58+
59+
[checks.vm]
60+
port = 5500
61+
type = 'http'
62+
interval = '15s'
63+
timeout = '10s'
64+
path = '/flycheck/vm'
65+
66+
[[metrics]]
67+
port = 9187
68+
path = '/metrics'
69+
https = false
70+
71+
[http_service]
72+
internal_port = 5432
73+
force_https = true
74+
auto_stop_machines = 'stop'
75+
auto_start_machines = true
76+
min_machines_running = 0
77+
processes = ['app']

‎fly.toml

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# fly.toml app configuration file generated for platzi-next-15 on 2024-12-12T01:51:21-05:00
2+
#
3+
# See https://fly.io/docs/reference/configuration/ for information about how to use this file.
4+
#
5+
6+
app = 'platzi-next-15'
7+
primary_region = 'bog'
8+
9+
[build]
10+
11+
[http_service]
12+
internal_port = 3000
13+
force_https = true
14+
auto_stop_machines = 'stop'
15+
auto_start_machines = true
16+
min_machines_running = 0
17+
processes = ['app']
18+
19+
[[vm]]
20+
memory = '1gb'
21+
cpu_kind = 'shared'
22+
cpus = 1

‎next.config.ts

+3
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,9 @@ const getSentryConfig = () =>
3131
hideSourceMaps: true,
3232
disableLogger: true,
3333
automaticVercelMonitors: false,
34+
sourcemaps: {
35+
deleteSourcemapsAfterUpload: true,
36+
},
3437
})
3538

3639
const CONFIG = enableSentry ? getSentryConfig() : nextConfig

‎package.json

+1
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
"react-dom": "19.0.0-rc-66855b96-20241106"
3838
},
3939
"devDependencies": {
40+
"@flydotio/dockerfile": "^0.5.9",
4041
"@types/node": "^20",
4142
"@types/react": "^18",
4243
"@types/react-dom": "^18",

0 commit comments

Comments
 (0)