Skip to content

Commit 3ae2b75

Browse files
committed
Prepare CYF fork
1 parent 2d9a6ad commit 3ae2b75

11 files changed

+38
-395
lines changed

.github/CODE_OF_CONDUCT.md

-132
This file was deleted.

.github/CONTRIBUTING.md

-19
This file was deleted.
File renamed without changes.
File renamed without changes.

.github/workflows/keepalive.yml

-12
This file was deleted.

.github/workflows/push.yml

+1-11
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,7 @@ on:
88
workflow_dispatch:
99

1010
jobs:
11-
windows:
12-
runs-on: windows-latest
13-
steps:
14-
- uses: textbook/take-action@nodejs
15-
with:
16-
node-version: 20
17-
- run: npm run lint
1811
nodejs:
19-
strategy:
20-
matrix:
21-
node: [20.9, 20, 22]
2212
runs-on: ubuntu-latest
2313
services:
2414
postgres:
@@ -38,7 +28,7 @@ jobs:
3828
steps:
3929
- uses: textbook/take-action@nodejs
4030
with:
41-
node-version: ${{ matrix.node }}
31+
node-version: 20
4232
- uses: textbook/take-action@playwright
4333
- run: npm run lint
4434
- run: npm run test:cover

README.md

+37
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Starter Kit v2
22

3+
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)
4+
35
- [x] [Node] LTS support (verified working on 20.x LTS release)
46
- [x] [Express] server
57
- [x] [Postgres] database with [`pg`][node-postgres]
@@ -15,6 +17,23 @@
1517
- [x] [Google App Engine], [Heroku], [Render] or [Vercel] deployment
1618
- [x] [Docker] build
1719

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+
1837
## Scripts
1938

2039
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:
2948
- `test`: runs the unit and integration tests.
3049
- `test:cover`: runs the tests and outputs coverage data.
3150

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.
64+
65+
[1]: https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template#creating-a-repository-from-a-template
66+
[2]: https://codeyourfuture.slack.com/archives/C021ATWS9A5
67+
[collaborators]: https://help.github.com/en/articles/inviting-collaborators-to-a-personal-repository
3268
[Docker]: https://www.docker.com
3369
[ESLint]: https://eslint.org/
3470
[Express]: https://expressjs.com/
@@ -42,6 +78,7 @@ commonly use:
4278
[Playwright]: https://playwright.dev/
4379
[Postgres]: https://www.postgresql.org/
4480
[Prettier]: https://prettier.io/
81+
[pull request]: https://help.github.com/en/articles/about-pull-requests
4582
[React]: https://reactjs.org/
4683
[React Router]: https://reactrouter.com/en/main
4784
[Render]: https://render.com/

bin/cyf.sh

-42
This file was deleted.

bin/files/README.md

-91
This file was deleted.

0 commit comments

Comments
 (0)