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

docs: add instructions for how to create a local account #365

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

fartinmartin
Copy link

What changed?

I've just set up my local environment by following CONTRIBUTING.md and ran into a few hiccups:

  1. When cloning the repo the initial checkout failed as I did not have git-lfs installed, so I added a note directing folks to install instructions.
  2. I wasn't sure if there is a way to login to your local Namesake app without an account, so I added instructions for how I created an early access code and registered an account.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 1, 2025
@evadecker
Copy link
Member

Hey @fartinmartin! Good to see ya :)

Thanks for ironing out some of the hiccups with setup. Definitely helpful to add a note about Git LFS!

Re: early access codes, I just added early access codes earlier this week—they're meant only for production, to limit access while we're still pre-release. I just created a ticket to remove that check for dev environments, so users can register without a code. That'll let us simplify the instructions here. Sorry for the headache!

@@ -26,6 +26,9 @@ cd namesake
pnpm install
```

> [!NOTE]
> Cloning the repo requires Git LFS (Large File Storage), see [install instructions](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage).
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> Cloning the repo requires Git LFS (Large File Storage), see [install instructions](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage).
> Cloning the repo requires Git LFS (Large File Storage). If you haven't installed Git LFS previously, follow the [installation instructions](https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage) before cloning.

Small copy edit! Thanks for adding this note!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants