Skip to content

Commit

Permalink
Prepare CYF fork
Browse files Browse the repository at this point in the history
  • Loading branch information
textbook committed Dec 1, 2024
1 parent 2d9a6ad commit 3ae2b75
Show file tree
Hide file tree
Showing 11 changed files with 38 additions and 395 deletions.
132 changes: 0 additions & 132 deletions .github/CODE_OF_CONDUCT.md

This file was deleted.

19 changes: 0 additions & 19 deletions .github/CONTRIBUTING.md

This file was deleted.

File renamed without changes.
File renamed without changes.
12 changes: 0 additions & 12 deletions .github/workflows/keepalive.yml

This file was deleted.

12 changes: 1 addition & 11 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,7 @@ on:
workflow_dispatch:

jobs:
windows:
runs-on: windows-latest
steps:
- uses: textbook/take-action@nodejs
with:
node-version: 20
- run: npm run lint
nodejs:
strategy:
matrix:
node: [20.9, 20, 22]
runs-on: ubuntu-latest
services:
postgres:
Expand All @@ -38,7 +28,7 @@ jobs:
steps:
- uses: textbook/take-action@nodejs
with:
node-version: ${{ matrix.node }}
node-version: 20
- uses: textbook/take-action@playwright
- run: npm run lint
- run: npm run test:cover
Expand Down
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Starter Kit v2

[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy)

- [x] [Node] LTS support (verified working on 20.x LTS release)
- [x] [Express] server
- [x] [Postgres] database with [`pg`][node-postgres]
Expand All @@ -15,6 +17,23 @@
- [x] [Google App Engine], [Heroku], [Render] or [Vercel] deployment
- [x] [Docker] build

## Setup

> **Note** if you have _any problems_ setting up the starter kit, see the [wiki] and, if still not solved, post to
> [`#cyf-full-stack-starter-kit` in Slack][2].
Pick one member of the team to own the repository and pipeline. That person should do the following:

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.
- Your repo should say _"generated from"_, **not** _"forked from"_, _"CodeYourFuture/cyf-final-project-starter-kit"_ at the top
2. In your repo, click the "Deploy to Render" button at the top of the README and log in using GitHub when prompted.
3. Fill in a service group name for your application and then click "Apply".
4. Once it has deployed successfully, click the "managed resources" link to view the application details.

Whenever you commit to main (or e.g. merge a [pull request]) it will get automatically deployed!

You should now make sure all of the project team are [collaborators] on the repository.

## Scripts

Various scripts are provided in the package file, but many are helpers for other scripts; here are the ones you'll
Expand All @@ -29,6 +48,23 @@ commonly use:
- `test`: runs the unit and integration tests.
- `test:cover`: runs the tests and outputs coverage data.

### Security

If the project handles **any kind of** Personally Identifiable Information (PII) then make sure the following
principles are followed:

- Only collect **strictly necessary** PII;
- Access to PII should be as restricted as possible;
- Access to PII should only be possible after authentication. Authentication **must be done** via GitHub. **Ad hoc
authentication solutions are not allowed**;
- Admins must be able to control who has access to the platform and at which levels using only GitHub groups;
- There must be an audit mechanism in place. It is required by law to know who accessed what and when;
- Code must be reviewed by senior developers before being pushed to production;
- APIs must be secure. Make sure we are not handling security on the frontend.

[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
[2]: https://codeyourfuture.slack.com/archives/C021ATWS9A5
[collaborators]: https://help.github.com/en/articles/inviting-collaborators-to-a-personal-repository
[Docker]: https://www.docker.com
[ESLint]: https://eslint.org/
[Express]: https://expressjs.com/
Expand All @@ -42,6 +78,7 @@ commonly use:
[Playwright]: https://playwright.dev/
[Postgres]: https://www.postgresql.org/
[Prettier]: https://prettier.io/
[pull request]: https://help.github.com/en/articles/about-pull-requests
[React]: https://reactjs.org/
[React Router]: https://reactrouter.com/en/main
[Render]: https://render.com/
Expand Down
42 changes: 0 additions & 42 deletions bin/cyf.sh

This file was deleted.

91 changes: 0 additions & 91 deletions bin/files/README.md

This file was deleted.

Loading

0 comments on commit 3ae2b75

Please sign in to comment.