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

Fixes #1557: Initial Typescript and NextJS Documentation #1695

Merged
merged 2 commits into from
Feb 17, 2021
Merged

Fixes #1557: Initial Typescript and NextJS Documentation #1695

merged 2 commits into from
Feb 17, 2021

Conversation

HyperTHD
Copy link
Contributor

Issue This PR Addresses

This PR fixes #1557

Type of Change

  • Bugfix: Change which fixes an issue
  • New Feature: Change which adds functionality
  • Documentation Update: Change which improves documentation
  • UI: Change which improves UI

Description

With the shift to NextJS and Typescript for our frontend instead of Gatsby, we decided to include some new documentation to point new Telescope developers to some very useful links that they can refer to. This is currently a draft-in-progress.
The theme decisions for NextJS was not included here since we already have a md file discussing styling and theme choices. I therefore, included a link to the Material-UI/Typescript documentation for future developers working on styling and theming.

Checklist

  • Quality: This PR builds and passes our npm test and works locally
  • Tests: This PR includes thorough tests or an explanation of why it does not
  • Screenshots: This PR includes screenshots or GIFs of the changes made or an explanation of why it does not (if applicable)
  • Documentation: This PR includes updated/added documentation to user exposed functionality or configuration variables are added/changed or an explanation of why it does not(if applicable)

@HyperTHD HyperTHD added the type: documentation (docs) Improvements or additions to documentation label Feb 11, 2021
@HyperTHD HyperTHD marked this pull request as draft February 11, 2021 18:49
@HyperTHD HyperTHD added the area: nextjs Nextjs related issues label Feb 11, 2021
@HyperTHD HyperTHD added this to the 1.7 Release milestone Feb 11, 2021
@HyperTHD HyperTHD self-assigned this Feb 11, 2021
@chrispinkney
Copy link
Contributor

Nice! I was going to comment to include the cheatsheet and the nextjs ts examples but you got both of them already. Great starting point so far 👍

@HyperTHD HyperTHD marked this pull request as ready for review February 12, 2021 18:36
@huyxgit huyxgit requested review from birtony and rjayroso February 16, 2021 15:13

When working on a new component for the Telescope frontend, please consider the following:

- We do not use React.FC/React.FunctionalComponent when making our components. The reason for this can be found [here](https://github.com/facebook/create-react-app/pull/8177).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrap React.FC and React.FunctionalComponent in backticks.


- We do not use React.FC/React.FunctionalComponent when making our components. The reason for this can be found [here](https://github.com/facebook/create-react-app/pull/8177).
- We require all components being created to strictly be exported directly inside the components folder. This is due to the way NextJS processes requests, where we build our pages in the `pages` folder using the components made there.
- Our style and theme choices can be found [here](./theme-and-colours.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of linking this, let's integrate this document into that file and rename it to docs/front-end.md, so all of our front-end notes are in one place.

@vercel
Copy link

vercel bot commented Feb 16, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/humphd/telescope/9hbym1cjq
✅ Preview: https://telescope-git-fork-hyperthd-issue-1557.humphd.now.sh

humphd
humphd previously approved these changes Feb 16, 2021
Copy link
Contributor

@humphd humphd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great stuff.

manekenpix
manekenpix previously approved these changes Feb 16, 2021
@HyperTHD HyperTHD merged commit faef920 into Seneca-CDOT:master Feb 17, 2021
@HyperTHD HyperTHD deleted the issue-1557 branch December 22, 2021 06:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: nextjs Nextjs related issues type: documentation (docs) Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add guide for working with TS, MUI, next.js
4 participants