Add enviroment variable

[theartcher]

Related issue #33

This PR proposes to do the following;

• Add .env variable support, with a default fallback to /.
• Remove old 'TODO' comment from config file.
• Add docs regarding config files.
• Update code standards regarding TODOs and FUTURE_WORKs.
• Add dotenv package.
• Fix navigator not using correct base URL.
• Add initial version of deployment docs.

[Copilot]

Pull request overview

This PR adds environment variable support for configuring the base URL of the Docusaurus site, addressing the need for flexible deployment configurations. The implementation allows the site to be deployed under different base paths (e.g., GitHub Pages repository paths) by reading from a BASE_URL environment variable with a fallback to the root path /.

Key changes:

• Add .env file support using the dotenv package for runtime configuration
• Refactor PatternResult component to use the configurable base URL from Docusaurus context instead of hardcoded values
• Update documentation with deployment guidelines and clarify coding standards around TODO/FUTURE_WORK comments

Reviewed changes

Copilot reviewed 4 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
src/components/navigator/PatternResult.tsx	Updated to retrieve base URL from Docusaurus customFields instead of using hardcoded value
package.json	Added dotenv dependency for environment variable support
package-lock.json	Added lockfile entries for dotenv package and updated version to 1.0.0
docusaurus.config.ts	Imported dotenv, read BASE_URL from environment, and passed it through customFields for client-side access
README.md	Added deployment section with .env configuration instructions and updated coding standard about TODO/FUTURE_WORK comments
.gitignore	Added .env to prevent committing environment variables

[Copilot]

Missing a period at the end of the sentence. The sentence should end with proper punctuation.

Suggested change

	This step is only necessary when you want to differ from the default `baseUrl` value of `/`. This is particularly useful when deploying to GitHub Pages under a repository, e.g., `https://username.github.io/repository-name/`, where the `BASE_URL` should be set to `/repository-name/`. See the [Docusaurus docs](https://docusaurus.io/docs/api/docusaurus-config#baseUrl) for more information
	This step is only necessary when you want to differ from the default `baseUrl` value of `/`. This is particularly useful when deploying to GitHub Pages under a repository, e.g., `https://username.github.io/repository-name/`, where the `BASE_URL` should be set to `/repository-name/`. See the [Docusaurus docs](https://docusaurus.io/docs/api/docusaurus-config#baseUrl) for more information.

[Copilot]

The hardcoded baseURL constant is now unused and should be removed. The component now retrieves the base URL from customFields instead.

Suggested change

const baseURL = "/DesignPatternPedia/docs";

[Copilot]

The type assertion for customFields.baseUrl should be added since customFields is typed as Record<string, unknown> in Docusaurus. Consider accessing it as (customFields.baseUrl as string | undefined) to ensure type safety.

Suggested change

	const baseUrlOrDefault = customFields.baseUrl || "/";
	const baseUrlOrDefault = (customFields.baseUrl as string | undefined) || "/";

[Copilot]

The URL construction logic may produce double slashes when baseUrlOrDefault is "/" (the default). For example, if baseUrlOrDefault is "/", the href will be "/docs/path", which is correct. However, if baseUrlOrDefault is "/repository-name/", the href will be "/repository-name/docs/path", which is also correct. But if baseUrlOrDefault doesn't end with a slash (which violates the documentation), this could produce incorrect URLs. Consider adding validation or a more robust URL joining mechanism.