Skip to content

Development Environment

Tony Tang edited this page Dec 21, 2019 · 2 revisions

Our files and packages

Recommend vscode editor. Works really fkcing well with typescript. Enable auto-fix/auto-format on save. Recommended extensions:

  • ESlint
  • Prettier
  • vscode-styled-components

package.json

  • lists our package dependencies
  • can contains scripts (such as npm start)
  • data about our app (description, name, licence)
  • may contain config info

package-lock.json

  • snapshot of all the dependencies that are needed for this app
  • should include this in git repo, so to guarentee that everyone has the same versions

tsconfig.json

eslint eslintConfig

  • linter for code styles
  • handles stuff like code smells, best practices, etc
  • https://eslint.org/

prettier (.prettierrc)

  • handles code formatting
  • tabs vs spaces, single vs double quotes, semicolons, breaking code into new lines
  • https://prettier.io/

Husky

Squashing commits

Squash commits when merging to clean up commit history.

https://github.blog/2016-04-01-squash-your-commits/

Docker

One container for the server (including database)

Testing

https://jestjs.io/

https://github.com/testing-library/react-testing-library

Dependabot

Keeps your packages up to date. Creates PR on

https://dependabot.com/

Storybook

https://storybook.js.org/

Deployment?

Clone this wiki locally