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

chore: update READMEs and make api endpoint configurable in clients #56

Merged
merged 19 commits into from
Aug 21, 2024

Conversation

anitarua
Copy link
Collaborator

@anitarua anitarua commented Aug 16, 2024

Adds readme generation workflow for the top-level README (can add for lower level ones if desired).

Updates the clients so that the API endpoint base url is a configurable environment variable rather than hardcoded since that value depends on the user's deployment setup. (Exception: I couldn't figure it out for the Android app so that one still directs users to hardcode it).

Ran each client locally to verify that they're all still working and the config changes worked.

Vercel preview deployments (available on PRs) use the preprod API endpoint now.
The prod Vercel deployment will use the prod API once this is merged to main.

Copy link

vercel bot commented Aug 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
moderated-chat ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 21, 2024 0:10am

frontend/README.md Outdated Show resolved Hide resolved

Once deployed, you can test your application using any of the client applications.

If you used the `API_DOMAIN="default"` option, you'll want to save the API gateway URL that was printed out.
Copy link
Contributor

Choose a reason for hiding this comment

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

💪

Copy link
Contributor

@rishtigupta rishtigupta left a comment

Choose a reason for hiding this comment

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

:shipit: LGTM!

Copy link
Contributor

@pgautier404 pgautier404 left a comment

Choose a reason for hiding this comment

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

🚢

@anitarua anitarua merged commit 3db033b into main Aug 21, 2024
3 checks passed
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.

4 participants