From 50749055bf502d56384c14e8982e08149922f567 Mon Sep 17 00:00:00 2001 From: Vivian Phung Date: Mon, 26 Feb 2024 17:33:44 -0500 Subject: [PATCH] ignore backend env file and readme --- .gitignore | 2 ++ README.md | 6 ++++++ packages/backend/.gitignore | 2 +- .../backend/environments/{local.toml => local.toml.example} | 0 4 files changed, 9 insertions(+), 1 deletion(-) rename packages/backend/environments/{local.toml => local.toml.example} (100%) diff --git a/.gitignore b/.gitignore index f6a00b4e..5bbf8847 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,5 @@ node_modules/ yarn-error.log .yarnrc.yml .yarn/ + +packages/backend/environments/local.toml \ No newline at end of file diff --git a/README.md b/README.md index a00412dc..8c2354c8 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,12 @@ cd packages/backend ``` +- Rename backend config file from [environments/local.toml.example](packages/backend/environments/local.toml.example) to `local.toml` + + ```bash + mv environments/local.toml.example environments/local.toml + ``` + - Set `gitHub.oAuth.clientId` and `gitHub.oAuth.clientSecret` in backend [config file](packages/backend/environments/local.toml) - Client ID and secret will be available after [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) - In "Homepage URL", type `http://localhost:3000` diff --git a/packages/backend/.gitignore b/packages/backend/.gitignore index 75c81f52..987e4095 100644 --- a/packages/backend/.gitignore +++ b/packages/backend/.gitignore @@ -1,3 +1,3 @@ db dist -environments \ No newline at end of file +environments/local.toml \ No newline at end of file diff --git a/packages/backend/environments/local.toml b/packages/backend/environments/local.toml.example similarity index 100% rename from packages/backend/environments/local.toml rename to packages/backend/environments/local.toml.example