You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 7, 2025. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+58-5Lines changed: 58 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,9 +12,45 @@
12
12
-[x] Dev mode (watch modes for client and server, proxy to avoid CORS issues)
13
13
-[x] Production build (single deployment artifact)
14
14
-[x][GitHub Actions] pipeline
15
-
-[x][Google App Engine], [Heroku], [Render] or [Vercel] deployment
15
+
-[x][Coolify], [Google App Engine], [Heroku], [Render] or [Vercel] deployment
16
16
-[x][Docker] build
17
-
-[x][Dev Containers] integration
17
+
18
+
## Setup
19
+
20
+
> **Note** if you have _any problems_ setting up the starter kit, see the [wiki] and, if still not solved, post to
21
+
> [`#cyf-full-stack-starter-kit` in Slack][2].
22
+
23
+
Pick one member of the team to own the repository and pipeline. That person should do the following:
24
+
25
+
1. Click the "Use this template" button above (see [GitHub's docs][1]) to create your team repository and name it something appropriate for your project.
26
+
- Your repo should say _"generated from"_, **not**_"forked from"_, _"CodeYourFuture/cyf-final-project-starter-kit"_ at the top
27
+
28
+
2. Make sure all of the project team are [collaborators] on the repository.
29
+
30
+
### Deploy to Coolify
31
+
32
+
This repo will work with the [Nixpack Node provider's][nixpacks-node] defaults, so deployment should be straightforward.
33
+
34
+
1. Create a new project
35
+
36
+
2. In the default "production" environment, create a Postgresql database
37
+
- Choose the default type
38
+
- Once it has started up, copy the "Postgres URL (internal)"
39
+
40
+
3. Also in the default "production" environment, create a "Git Based > Public Repository" resource
41
+
- Choose your repository URL
42
+
- Under "Environment Variables", set `PGSSLMODE` to `disable` and `DATABASE_URL` to the URL you copied above
43
+
- Under "Healthcheck", check "Enabled", set the Path to `/healthz` and the Return Code to 301
44
+
- Under "Webhooks", copy the "Manual Git Webhooks > GitHub" URL then follow the link to "Webhook configuration on GitHub" to add this to your repo
45
+
- Use the command `python3 -c 'import secrets;print(secrets.token_hex(16))'` to generate a good secret
46
+
47
+
### Deploy to Render
48
+
49
+
[](https://render.com/deploy)
50
+
51
+
1. In your repo, click the "Deploy to Render" button in the relevant section of the README and log in using GitHub when prompted.
52
+
2. Fill in a service group name for your application and then click "Apply".
53
+
3. Once it has deployed successfully, click the "managed resources" link to view the application details.
18
54
19
55
## Scripts
20
56
@@ -25,27 +61,44 @@ commonly use:
25
61
-`e2e`: builds and starts the app in production mode and runs the Playwright tests against it.
26
62
-`e2e:dev`: builds and starts the app in dev mode and runs the Playwright tests against it.
27
63
-`lint`: runs ESLint and Prettier against all the relevant files in the project.
28
-
-`format`: reformats the code with Prettier.
29
-
-`lint:fix`: attempts to fix all ESLint and Prettier violations.
30
64
-`serve`: builds and starts the app in production mode locally.
31
65
-`ship`: runs `lint`, then `test`, then `e2e`; ideal before a `git push`.
32
66
-`test`: runs the unit and integration tests.
33
67
-`test:cover`: runs the tests and outputs coverage data.
0 commit comments