From c05bfc8ddca852b286e4882673aa93f3b22282ef Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Mon, 25 Mar 2024 16:05:40 -0500 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20instructions=20to=20clo?= =?UTF-8?q?ne=20for=20a=20private=20repo,=20including=20updates=20(#1127)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) diff --git a/README.md b/README.md index 73ec56f..2dfc69f 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,74 @@ You can **just fork or clone** this repository and use it as is. ✨ It just works. ✨ +### How to Use a Private Repository + +If you want to have a private repository, GitHub won't allow you to simply fork it as it doesn't allow changing the visibility of forks. + +But you can do the following: + +- Create a new GitHub repo, for example `my-full-stack`. +- Clone this repository manually, set the name with the name of the project you want to use, for example `my-full-stack`: + +```bash +git clone git@github.com:tiangolo/full-stack-fastapi-template.git my-full-stack +``` + +- Enter into the new directory: + +```bash +cd my-full-stack +``` + +- Set the new origin to your new repository, copy it from the GitHub interface, for example: + +```bash +git remote set-url origin git@github.com:octocat/my-full-stack.git +``` + +- Add this repo as another "remote" to allow you to get updates later: + +```bash +git remote add upstream git@github.com:tiangolo/full-stack-fastapi-template.git +``` + +- Push the code to your new repository: + +```bash +git push -u origin master +``` + +### Update From the Original Template + +After cloning the repository, and after doing changes, you might want to get the latest changes from this original template. + +- Make sure you added the original repository as a remote, you can check it with: + +```bash +git remote -v + +origin git@github.com:octocat/my-full-stack.git (fetch) +origin git@github.com:octocat/my-full-stack.git (push) +upstream git@github.com:tiangolo/full-stack-fastapi-template.git (fetch) +upstream git@github.com:tiangolo/full-stack-fastapi-template.git (push) +``` + +- Pull the latest changes without merging: + +```bash +git pull --no-commit upstream master +``` + +This will download the latest changes from this template without committing them, that way you can check everything is right before committing. + +- If there are conflicts, solve them in your editor. + +- Once you are done, commit the changes: + +```bash +git merge --continue +``` + ### Configure You can then update configs in the `.env` files to customize your configurations.