Skip to content

docs: add missing .env.example referenced in setup guide#66

Open
Prime-victor wants to merge 14 commits into
SpaceyaTech:devfrom
Prime-victor:fix/add-env-example
Open

docs: add missing .env.example referenced in setup guide#66
Prime-victor wants to merge 14 commits into
SpaceyaTech:devfrom
Prime-victor:fix/add-env-example

Conversation

@Prime-victor
Copy link
Copy Markdown

Summary

The setup guide references a .env.example file:

cp .env.example .env

However, this file does not exist in the repository, causing setup errors for new contributors.

This PR adds the missing .env.example file to fix onboarding and align documentation with the actual project structure.

🏷️ Type of Change

  • docs
  • enhancement

🌍 Scope

  • frontend

🔗 Related Issues

Closes #0 (documentation mismatch)

🧪 Testing

  • Verified setup guide references .env.example
  • Confirmed file exists in repository
  • Validated no sensitive values included

⚠️ Breaking Changes

None


📝 Notes for Reviewers

This is a documentation alignment fix to improve onboarding.

New contributors previously could not follow setup instructions due to missing .env.example file.

The file only contains environment variable keys (no secrets).

jlc254 and others added 3 commits April 16, 2026 19:11
chore: add security workflow and update gitignore to exclude sensitiv…
…anches--main--components--vite_react_shadcn_ts

chore(main): release 1.1.0
@vercel
Copy link
Copy Markdown

vercel Bot commented May 1, 2026

@Prime-victor is attempting to deploy a commit to the jumalaw98's projects Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

🎉 Welcome to Colabs! Thanks for your first contribution!

We're excited to have you on board 🙌 Your work helps empower the global developer community.
A maintainer will review your PR shortly.

Copy link
Copy Markdown

@cubic-dev-ai cubic-dev-ai Bot left a comment

Choose a reason for hiding this comment

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

No issues found across 1 file

Copy link
Copy Markdown
Contributor

@jumalaw98 jumalaw98 left a comment

Choose a reason for hiding this comment

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

Update changes look fine, review the failing workflow #changelog preview and fix it
Rebase and also make pr to the main branch

@jumalaw98 jumalaw98 changed the base branch from main to dev May 5, 2026 11:01
@Prime-victor Prime-victor changed the title fix: add missing .env.example referenced in setup guide docs: add missing .env.example referenced in setup guide May 6, 2026
@Prime-victor
Copy link
Copy Markdown
Author

The changelog-preview workflow is failing due to GitHub Actions permissions.
Error:
403 Resource not accessible by integration
The workflow is trying to post PR comments via actions/github-script but lacks:

  • issues: write
  • pull-requests: write

@Prime-victor Prime-victor changed the base branch from dev to main May 6, 2026 14:03
Prime-victor and others added 9 commits May 7, 2026 10:10
Bumps [amannn/action-semantic-pull-request](https://github.com/amannn/action-semantic-pull-request) from 5.5.3 to 6.1.1.
- [Release notes](https://github.com/amannn/action-semantic-pull-request/releases)
- [Changelog](https://github.com/amannn/action-semantic-pull-request/blob/main/CHANGELOG.md)
- [Commits](amannn/action-semantic-pull-request@0723387...48f2562)

---
updated-dependencies:
- dependency-name: amannn/action-semantic-pull-request
  dependency-version: 6.1.1
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps the react-ecosystem group with 1 update: [react-router-dom](https://github.com/remix-run/react-router/tree/HEAD/packages/react-router-dom).


Updates `react-router-dom` from 7.14.0 to 7.14.1
- [Release notes](https://github.com/remix-run/react-router/releases)
- [Changelog](https://github.com/remix-run/react-router/blob/main/packages/react-router-dom/CHANGELOG.md)
- [Commits](https://github.com/remix-run/react-router/commits/react-router-dom@7.14.1/packages/react-router-dom)

---
updated-dependencies:
- dependency-name: react-router-dom
  dependency-version: 7.14.1
  dependency-type: direct:production
  update-type: version-update:semver-patch
  dependency-group: react-ecosystem
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps the linting-formatting group with 1 update: [prettier](https://github.com/prettier/prettier).


Updates `prettier` from 3.8.2 to 3.8.3
- [Release notes](https://github.com/prettier/prettier/releases)
- [Changelog](https://github.com/prettier/prettier/blob/main/CHANGELOG.md)
- [Commits](prettier/prettier@3.8.2...3.8.3)

---
updated-dependencies:
- dependency-name: prettier
  dependency-version: 3.8.3
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: linting-formatting
...

Signed-off-by: dependabot[bot] <support@github.com>
…ith 4 updates

Bumps the tailwind-postcss group with 3 updates in the / directory: [@tailwindcss/postcss](https://github.com/tailwindlabs/tailwindcss/tree/HEAD/packages/@tailwindcss-postcss), [autoprefixer](https://github.com/postcss/autoprefixer) and [postcss](https://github.com/postcss/postcss).


Updates `@tailwindcss/postcss` from 4.2.2 to 4.2.4
- [Release notes](https://github.com/tailwindlabs/tailwindcss/releases)
- [Changelog](https://github.com/tailwindlabs/tailwindcss/blob/main/CHANGELOG.md)
- [Commits](https://github.com/tailwindlabs/tailwindcss/commits/v4.2.4/packages/@tailwindcss-postcss)

Updates `autoprefixer` from 10.4.27 to 10.5.0
- [Release notes](https://github.com/postcss/autoprefixer/releases)
- [Changelog](https://github.com/postcss/autoprefixer/blob/main/CHANGELOG.md)
- [Commits](postcss/autoprefixer@10.4.27...10.5.0)

Updates `postcss` from 8.5.9 to 8.5.14
- [Release notes](https://github.com/postcss/postcss/releases)
- [Changelog](https://github.com/postcss/postcss/blob/main/CHANGELOG.md)
- [Commits](postcss/postcss@8.5.9...8.5.14)

Updates `tailwindcss` from 4.2.2 to 4.2.4
- [Release notes](https://github.com/tailwindlabs/tailwindcss/releases)
- [Changelog](https://github.com/tailwindlabs/tailwindcss/blob/main/CHANGELOG.md)
- [Commits](https://github.com/tailwindlabs/tailwindcss/commits/v4.2.4/packages/tailwindcss)

---
updated-dependencies:
- dependency-name: "@tailwindcss/postcss"
  dependency-version: 4.2.4
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: tailwind-postcss
- dependency-name: autoprefixer
  dependency-version: 10.5.0
  dependency-type: direct:development
  update-type: version-update:semver-minor
  dependency-group: tailwind-postcss
- dependency-name: postcss
  dependency-version: 8.5.12
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: tailwind-postcss
- dependency-name: tailwindcss
  dependency-version: 4.2.4
  dependency-type: direct:development
  update-type: version-update:semver-patch
  dependency-group: tailwind-postcss
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [googleapis/release-please-action](https://github.com/googleapis/release-please-action) from 4.1.3 to 5.0.0.
- [Release notes](https://github.com/googleapis/release-please-action/releases)
- [Changelog](https://github.com/googleapis/release-please-action/blob/main/CHANGELOG.md)
- [Commits](googleapis/release-please-action@7987652...45996ed)

---
updated-dependencies:
- dependency-name: googleapis/release-please-action
  dependency-version: 5.0.0
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [actions/github-script](https://github.com/actions/github-script) from 7 to 9.
- [Release notes](https://github.com/actions/github-script/releases)
- [Commits](actions/github-script@v7...v9)

---
updated-dependencies:
- dependency-name: actions/github-script
  dependency-version: '9'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
Bumps [actions/setup-node](https://github.com/actions/setup-node) from 4 to 6.
- [Release notes](https://github.com/actions/setup-node/releases)
- [Commits](actions/setup-node@v4...v6)

---
updated-dependencies:
- dependency-name: actions/setup-node
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
@Prime-victor Prime-victor changed the base branch from main to dev May 7, 2026 07:11
@Prime-victor Prime-victor force-pushed the fix/add-env-example branch from 0662d2c to 92bc69b Compare May 7, 2026 07:16
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 7, 2026

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants