Merge pull request #184 from TheSoftwareHouse/docs/update-readme-with…

…-env-local docs: enhance README with instructions on setting up the .env.local file
TheSoftwareHouse · May 13, 2024 · 0d67543 · 0d67543
2 parents ff3c453 + 825b850
commit 0d67543
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 7 deletions.
diff --git a/.changeset/twelve-emus-hear.md b/.changeset/twelve-emus-hear.md
@@ -0,0 +1,5 @@
+---
+"react-starter-boilerplate": patch
+---
+
+Enhance README with instructions on setting up the .env.local file
diff --git a/.gitignore b/.gitignore
@@ -14,7 +14,7 @@
 # misc
 .DS_Store
 .env.babelsheet
-.env
+.env.local
 
 # editor files
 .idea/

diff --git a/README.md b/README.md
@@ -65,6 +65,12 @@ git commit -m 'Initial commit'
 git push origin master
 ```
 
+6. Copy the `.env.dist` file to `.env.local` and populate the environment variables with the values used in the local environment
+
+```shell
+cp .env.dist .env.local
+```
+
 Now, your project is bootstrapped successfully! 🎉
 
 You can install dependencies and start developing your React application 🚀

diff --git a/package-lock.json b/package-lock.json