Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Environment variable examples
BCRYPT_SALT=""
COMPOSE_PROJECT_NAME=""
DB_NAME=""
DB_PASSWORD=""
DB_PORT=""
DB_URL=""
DB_USER=""
PORT=""
VITE_REACT_APP_SERVER_URL=""
Copy link
Author

Choose a reason for hiding this comment

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

Missing JWT-related environment variables

JWT_SECRET_KEY and JWT_EXPIRATION are required by the server (see apps/hotel-management-service-server/README.md) but are absent from .env.example, risking misconfiguration and runtime failures.

Suggested fix: Add the following placeholders (with explanatory comments) to .env.example:

JWT_SECRET_KEY=""
JWT_EXPIRATION=""

Copy link
Author

Choose a reason for hiding this comment

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

Inconsistent client server URL variable name

Frontend code expects process.env.REACT_APP_SERVER_URL (see Login.tsx / LoginForm.tsx) but .env.example defines VITE_REACT_APP_SERVER_URL, which will be undefined at runtime.

Suggested fix: Rename the variable in .env.example to REACT_APP_SERVER_URL or update the frontend code to use import.meta.env.VITE_REACT_APP_SERVER_URL per Vite convention.

6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Sensitive files
*.env
*.env.*

# Allow the public template
!.env.example
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,26 @@ npm run test

---

## Security & Secret Management

**Important:** As of [PR #??](https://github.com/overcut-ai/awesome-overcut/pull/XXX) we removed all plaintext secret files from version control.
Copy link
Author

Choose a reason for hiding this comment

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

Placeholder PR link left in docs

PR #?? / pull/XXX placeholders need to be replaced with the actual PR number so future readers can access the referenced change.

Suggested fix: Update the sentence to reference this PR: [PR #89](https://github.com/overcut-ai/awesome-overcut/pull/89).


1. Secrets such as database credentials and API keys **must not** be committed to the repository.
2. Runtime configuration is supplied exclusively via **environment variables** or your CI/CD secrets store.
3. A template file [`.env.example`](./.env.example) lists all required variables with empty placeholder values. Copy it to `.env` (which is git-ignored) and fill in values for **local development only**:

```bash
cp .env.example .env # create local env file
# then edit .env and set the variables
```

4. For production/staging environments use your orchestrator (Docker, Kubernetes, Vercel, etc.) or a dedicated secrets manager (AWS Secrets Manager, HashiCorp Vault, etc.) to inject environment variables securely.
5. Our CI pipeline includes secret-scanning to prevent accidental leaks on future commits.
Copy link
Author

Choose a reason for hiding this comment

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

CI secret-scanning claim inaccurate

The documentation states that the CI pipeline already includes secret scanning, but this PR explicitly says the workflow is deferred due to permissions. Documenting a non-existent control can mislead contributors.

Suggested fix: Clarify that secret-scanning will be added in a follow-up once permissions are granted, or link to the relevant workflow if it already exists.


---

---

## Contributing

Pull requests are welcome! For major changes please open an issue first to discuss what you would like to change.
Expand Down
2 changes: 0 additions & 2 deletions apps/hotel-management-service-admin/.env

This file was deleted.

8 changes: 0 additions & 8 deletions apps/hotel-management-service-server/.env

This file was deleted.