/env

Development environmnet setup for working at WhaleTaleDesigns.

Primary LanguageShell

@WhaleTaleDesigns/env

Development environmnet setup for working with WhaleTaleDesigns projects.

What's next? How do I make an app with this?

  • Install VSCode and the Dev Containers extension.
  • Clone this project and then open it VSCode.
  • Install Docker if you haven't already.
  • Open the project in a dev container:
    • VSCode should prompt you to do this. If not, open the Command Palette (⌘⇧P) and run Dev Containers: Open Folder in Container....
  • After the dev container has initialized:
    • At the end of the dev container's setup log, you should see a newly generated public SSH key in red. Add this key to GitHub.
      • This step is optional, but strongly recommended in order to avoid needing to enter your GitHub credentials (or public access key) when running git commands.
      • Optional: Customize your terminal prompt using tide, which is already installed for you.
    • Clone the app you will be working on into the workspace.
      • If you are making a new app, fork the base app as a starting point and then clone that app into the dev container.
    • Setup your git name and email:
      • git config --global user.email "your@email.com"
      • git config --global user.name "Your Name"