Skip to content
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.

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

docs(readme): improve guide on how to create an application and link it #248

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

Conversation

vladjerca
Copy link
Collaborator

@vladjerca vladjerca commented Jan 10, 2025

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"):

  • The 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"):

  • New scripts, like magical incantations, appear within the deno.json and projects/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. The client: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 configurations, once a source of confusion and frustration, now dance in perfect harmony, their settings carefully adjusted to ensure a seamless transition between production and development realms. The default environment, now set to Environment.production, provides a stable foundation for the application, while the TRAKT_TARGET_ENVIRONMENT variable, now intertwined with the IS_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"):

  • Authentication protocols, those guardians of user data and privacy, receive a reinforcement, their defenses bolstered by the 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.

@vladjerca vladjerca requested a review from seferturan January 10, 2025 21:37
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.

1 participant