Skip to content

Update README.md with .env instructions #2

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.

Sign up for GitHub

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

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

Update README.md with .env instructions #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45ed97d
Update README.md with .env instructions
ansonkao Jul 28, 2023
6cef633
Update .env.example with defaults
ansonkao Jul 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .env.example
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# App's running environment
NODE_ENV=
NODE_ENV=development

# App's running port
PORT=
PORT=9001

# Cors origin url
CORS_ORIGIN=
CORS_ORIGIN=
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,13 @@ Go to the project directory
yarn install
```

Set your environment variables following the provided `.env.example` template.
```bash
cp .env.example .env
```

If desired, change the default values in your preferred code editor.

### Linting

```bash
Expand Down