Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add guides for deployments #515

Closed
wants to merge 4 commits into from

Conversation

sztupy
Copy link
Contributor

@sztupy sztupy commented Jan 9, 2024

What does this change?

This changes the following:

  1. Move all deployment related guides (Previously Netlify and Render) under a "Deployment" section
  2. Add some notes on what deployment is, what free options there are and what the limitations of each of these options are
  3. Adds section for fly.io deployment
  4. Adds section for backend deployment on Netlify
  5. Adds section for registering for Supabase

Note: this is WIP, some of the guides would be meant to accompany the re-done Full-Stack-Assessment (and potentially the Final Projects), which is still in works. The links on some pages therefore still link to my own github for examples instead of CYF ones, that would be fixed later. Also not sure whether the added guides adhere to our pedagogical standards - they are mostly how I explained deployments to GLA-6, and try to answer questions that were raised during classes.

Checklist

Copy link

netlify bot commented Jan 9, 2024

Deploy Preview for cyf-curriculum ready!

Name Link
🔨 Latest commit 3a65f10
🔍 Latest deploy log https://app.netlify.com/sites/cyf-curriculum/deploys/65b44f1b204d6c0008588b3f
😎 Deploy Preview https://deploy-preview-515--cyf-curriculum.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 86 (🔴 down 13 from production)
Accessibility: 100 (no change from production)
Best Practices: 100 (no change from production)
SEO: 91 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@sztupy sztupy force-pushed the update-deployment-section branch 2 times, most recently from 0e74dd0 to a6c26dc Compare January 13, 2024 12:16
This changes the following:

1. Move all deployment related guides (Previously Netlify and Render) under a "Deployment" section
2. Add some notes on what deployment is, what free options there are and what the limitations of each of these options are
3. Adds section for fly.io deployment
4. Adds section for backend deployment on Netlify (this links to code that is on my GitHub account - will move to CYF once the Full Stack assessment reorg is done)
5. Adds section for registering for Supabase
@sztupy sztupy force-pushed the update-deployment-section branch from a6c26dc to 522df48 Compare January 13, 2024 21:15
…tion

* origin/main: (26 commits)
  fix objective indexing
  restore js3 prep workshops
  making site run again now modules are being consumed correctly (CodeYourFuture#541)
  Feature: replace labs again (CodeYourFuture#540)
  Update: move netlify tooling (CodeYourFuture#539)
  feature; stage 2: mounting this repo as modules (CodeYourFuture#538)
  Feature: stage 1: port labs  (CodeYourFuture#537)
  Feature: Daniel's tooling for local module replacements (CodeYourFuture#535)
  Update style of the hamburger menu (CodeYourFuture#478) (CodeYourFuture#528)
  Update content/en/js3/success/index.md
  Update content/en/js3/success/index.md
  add step->prep workshops for JS2 & JS3
  Add minutes
  archetypes for all required module views (CodeYourFuture#529)
  add major change warning (CodeYourFuture#527)
  parametrize createFilmCard with template (CodeYourFuture#524)
  link to the module js3 project
  reference the module js3 project success criteria in the js3 module success page
  Update index adding PD success.md (CodeYourFuture#518)
  Update index Prep DB/SQL S4 PD.md (CodeYourFuture#511)
  ...
The GITHUB TOKEN's environment name has changed recently but this was not reflected in the readme and the .env configs. This change also makes sure that the .env file values are proeprly picked up, and that the README is updated to help new users be able to set up their local dev environment quicker
…ent-section

* core/fix-env-setup:
  Fix environment setup in new structure
sztupy added a commit to sztupy/Full-Stack-Project-Assessment that referenced this pull request Jan 26, 2024
This is the proposed v2 update to the Full Stack Assessment Project. Main changes:

1. Use a monorepo approach based on `textbook/starter-kit/v2`, but stripped down with some parts removed to make it lighter and easier to navigate. These includes a much smaller `package.json` file with less available commands, no support for test coverage, plain `console.log` logging instead of morgan, no built-in support for helmet, and removed most of the deployment targets, keeping Netlify only.
2. Reorganized the assessment based on features instead of splitting it alongside frontend and backend. Week 1 is an MVP, Week 2 adds video embedding and the add/remove functionality, while Week 3 ends with ratings support
3. Optional features have been reorganized and expanded, one part code style improvements: linting, unit tests, e2e tests. The other part are better error handling. There are still a couple small optional product features as well.

Note that the scope of the mandatory part of the project mostly remains the exact same as before, but there are some new requirements:

1. Deployment is now mandatory, with most of its setup happening during Week 1. Deployment setup is toward Netlify and Supabase using the proposed updates to the deployment section in our curriculum: CodeYourFuture/curriculum#515
2. Data validation is now mandatory on the backend side for the "Add video" feature. (It is technically still optionali, but strongly recommended through the frontend)
3. Ratings now have to be persisted to the database through the API (this was theoretically already a requirement, however due to how the assessment was worded on the backend side it effectively became an optional feature accidentally)

The core repository also contains some predefined files for the frontend, backend and e2e tests to get the trainees a starting point, especially as we don't really teach them how this is done.
sztupy added a commit to sztupy/Full-Stack-Project-Assessment that referenced this pull request Jan 27, 2024
This is the proposed v2 update to the Full Stack Assessment Project. Main changes:

1. Use a monorepo approach based on `textbook/starter-kit/v2`, but stripped down with some parts removed to make it lighter and easier to navigate. These includes a much smaller `package.json` file with less available commands, no support for test coverage, plain `console.log` logging instead of morgan, no built-in support for helmet, and removed most of the deployment targets, keeping Netlify only.
2. Reorganized the assessment based on features instead of splitting it alongside frontend and backend. Week 1 is an MVP, Week 2 adds video embedding and the add/remove functionality, while Week 3 ends with ratings support
3. Optional features have been reorganized and expanded, one part code style improvements: linting, unit tests, e2e tests. The other part are better error handling. There are still a couple small optional product features as well.

Note that the scope of the mandatory part of the project mostly remains the exact same as before, but there are some new requirements:

1. Deployment is now mandatory, with most of its setup happening during Week 1. Deployment setup is toward Netlify and Supabase using the proposed updates to the deployment section in our curriculum: CodeYourFuture/curriculum#515
2. Data validation is now mandatory on the backend side for the "Add video" feature. (It is technically still optionali, but strongly recommended through the frontend)
3. Ratings now have to be persisted to the database through the API (this was theoretically already a requirement, however due to how the assessment was worded on the backend side it effectively became an optional feature accidentally)

The core repository also contains some predefined files for the frontend, backend and e2e tests to get the trainees a starting point, especially as we don't really teach them how this is done.
@sztupy sztupy marked this pull request as ready for review January 27, 2024 01:09
@sztupy sztupy closed this Jan 27, 2024
sztupy added a commit to sztupy/curriculum that referenced this pull request Jan 27, 2024
For more info see CodeYourFuture#515

This is splitting out that PR into multiple parts. This is part 1 - the core description for deployments
sztupy added a commit to sztupy/curriculum that referenced this pull request Jan 27, 2024
For more info see CodeYourFuture#515

This is splitting out that PR into multiple parts. This is part 2 - Netlify
sztupy added a commit to sztupy/curriculum that referenced this pull request Jan 27, 2024
For more info see CodeYourFuture#515

This is splitting out that PR into multiple parts. This is part 3 - Render
sztupy added a commit to sztupy/curriculum that referenced this pull request Jan 27, 2024
For more info see CodeYourFuture#515

This is splitting out that PR into multiple parts. This is part 4 - Fly.io
sztupy added a commit to sztupy/curriculum that referenced this pull request Jan 27, 2024
For more info see CodeYourFuture#515

This is splitting out that PR into multiple parts. This is part 5 - Supabase
@sztupy
Copy link
Contributor Author

sztupy commented Jan 27, 2024

Closed, replaced by

#554
#555
#556
#557
#558

SallyMcGrath pushed a commit that referenced this pull request Mar 21, 2024
* Refactor Netlify deployment, adding backend notes

For more info see #515

This is splitting out that PR into multiple parts. This is part 2 - Netlify

* add sally's edits to deploying backends to netlify

* mv to correct dir

* more tidying up

* restore links to deployment guide

---------

Co-authored-by: Dedekind561 <[email protected]>
SallyMcGrath pushed a commit that referenced this pull request Mar 21, 2024
* Add guide to install databases to Supabase

For more info see #515

This is splitting out that PR into multiple parts. This is part 5 - Supabase

* mv and tidy supabase deployment guide

* add copy-edits

---------

Co-authored-by: Dedekind561 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

1 participant