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

Setup a more detailed contributor guide for web. #35

Closed
fozziethebeat opened this issue Dec 19, 2022 · 0 comments · Fixed by #45
Closed

Setup a more detailed contributor guide for web. #35

fozziethebeat opened this issue Dec 19, 2022 · 0 comments · Fixed by #45

Comments

@fozziethebeat
Copy link
Collaborator

This should includes some best practices and how to setup a local dev environment.

Best Practices

This should cover anything not handled by prettier such as:

  • Preferred component patterns, one of
    1. class SomeComponent extends React.Component<SomeComponentProps, {}> {...}
    2. const SomeComponent = (props: SomeComponentProps) => {...};
    3. const SomeComponent: React.FC<SomeComponentProps> = (props) => {...};
  • Preferred ways to use useSWR* hooks.
  • Preference for useRef when feasible.
  • Suggestions on updating state (especially with arrays).

Setup

This should include

  • Pointer to running the backend stack in scripts/frontend-development.
  • Updating the helper script with a web DB
  • Some usable env variables for
    • NEXTAUTH_SECRET
    • DISCORD_CLIENT_ID
    • DISCORD_CLIENT_SECRET
    • EMAIL_SERVER_USER
    • EMAIL_SERVER_PASSWORD
    • EMAIL_SERVER_HOST
    • EMAIL_SERVER_PORT
    • EMAIL_FROM
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

1 participant