docs(readme): improve guide on how to create an application and link it #248
+67
−6
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request, a grand symphony of developer-centric enhancements, orchestrates a series of changes designed to transform the Trakt Lite codebase into a welcoming haven for external contributors. Observe, with a mix of admiration and anticipation, the metamorphosis of the README.md, the introduction of new development scripts, the harmonization of environment configurations, and the fortification of authentication protocols.
The README.md Transformation (or, "A Map for the Lost and the Brave"):
README.md
file, once a cryptic and intimidating tome, now blossoms into a welcoming guide, its pages filled with clear and concise instructions for those brave souls venturing into the Trakt Lite wilderness. This transformation, a testament to our newfound appreciation for external contributors, promises to ease the onboarding process and empower developers to contribute their talents to the project.Development Scripts: A Symphony of Automation (or, "The Conductor's Baton"):
deno.json
andprojects/client/package.json
files, their purpose to automate the tedious tasks of development and free developers to focus on the creative aspects of code creation. Theclient:dev:contrib
script, a maestro's baton in the hands of a skilled developer, orchestrates the client in development mode, ensuring a harmonious and efficient workflow.Environment Configuration: A Balancing Act (or, "The Environment Juggler"):
Environment.production
, provides a stable foundation for the application, while theTRAKT_TARGET_ENVIRONMENT
variable, now intertwined with theIS_CONTRIB
variable, allows for flexible switching between different modes, like a skilled stagehand effortlessly changing scenery without disrupting the performance.Authentication Handling: A Fortress of Security (or, "The Digital Bouncer"):
prependHttpOrHttps
utility function. This vigilant gatekeeper, a digital bouncer with a keen eye for detail, ensures that referrers are properly formatted and authenticated, preventing unauthorized access and maintaining the integrity of the Trakt Lite ecosystem.These changes, a symphony of developer-centric enhancements, collectively transform the Trakt Lite codebase into a welcoming and accessible platform for external contributors. The result is a more streamlined and user-friendly development experience, where documentation is clear, scripts automate tedious tasks, environments transition seamlessly, and authentication protocols stand guard against unauthorized access.