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
Copy file name to clipboardexpand all lines: README.md
+37
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,7 @@
1
1
# Starter Kit v2
2
2
3
+
[](https://render.com/deploy)
4
+
3
5
-[x][Node] LTS support (verified working on 20.x LTS release)
4
6
-[x][Express] server
5
7
-[x][Postgres] database with [`pg`][node-postgres]
@@ -15,6 +17,23 @@
15
17
-[x][Google App Engine], [Heroku], [Render] or [Vercel] deployment
16
18
-[x][Docker] build
17
19
20
+
## Setup
21
+
22
+
> **Note** if you have _any problems_ setting up the starter kit, see the [wiki] and, if still not solved, post to
23
+
> [`#cyf-full-stack-starter-kit` in Slack][2].
24
+
25
+
Pick one member of the team to own the repository and pipeline. That person should do the following:
26
+
27
+
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.
28
+
- Your repo should say _"generated from"_, **not**_"forked from"_, _"CodeYourFuture/cyf-final-project-starter-kit"_ at the top
29
+
2. In your repo, click the "Deploy to Render" button at the top of the README and log in using GitHub when prompted.
30
+
3. Fill in a service group name for your application and then click "Apply".
31
+
4. Once it has deployed successfully, click the "managed resources" link to view the application details.
32
+
33
+
Whenever you commit to main (or e.g. merge a [pull request]) it will get automatically deployed!
34
+
35
+
You should now make sure all of the project team are [collaborators] on the repository.
36
+
18
37
## Scripts
19
38
20
39
Various scripts are provided in the package file, but many are helpers for other scripts; here are the ones you'll
@@ -29,6 +48,23 @@ commonly use:
29
48
-`test`: runs the unit and integration tests.
30
49
-`test:cover`: runs the tests and outputs coverage data.
31
50
51
+
### Security
52
+
53
+
If the project handles **any kind of** Personally Identifiable Information (PII) then make sure the following
54
+
principles are followed:
55
+
56
+
- Only collect **strictly necessary** PII;
57
+
- Access to PII should be as restricted as possible;
58
+
- Access to PII should only be possible after authentication. Authentication **must be done** via GitHub. **Ad hoc
59
+
authentication solutions are not allowed**;
60
+
- Admins must be able to control who has access to the platform and at which levels using only GitHub groups;
61
+
- There must be an audit mechanism in place. It is required by law to know who accessed what and when;
62
+
- Code must be reviewed by senior developers before being pushed to production;
63
+
- APIs must be secure. Make sure we are not handling security on the frontend.
0 commit comments