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(web-service): update readme with local dev guidance #1414

Merged
merged 6 commits into from
May 16, 2023

Conversation

KClough
Copy link
Collaborator

@KClough KClough commented Apr 29, 2023

Summary:

Update readme to include additional steps + guidance for local development.

Expected behavior:

Explain and/or show screenshots for how you expect the pull request to work in your testing (in case other devices exhibit different behavior).

Please make sure these boxes are checked before submitting your pull request - thanks!

  • Run the unit tests with gradle test to make sure you didn't break anything
  • Format the title like "feat: [new feature short description]". Title must follow the Conventional Commit Specification(https://www.conventionalcommits.org/en/v1.0.0/).
  • Linked all relevant issues
  • Include screenshot(s) showing how this pull request works and fixes the issue(s)


Once this is completed, the server can be started by running `./gradlew bootRun` in the root of the project.

**Note**: The `web/service/src/test/resources/web-based-gtfs-validator.json` contains a valid primary key, but it is not tied to a valid Google Cloud Service Account.
Copy link
Member

Choose a reason for hiding this comment

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

👍

web/service/README.md Outdated Show resolved Hide resolved
@davidgamez davidgamez merged commit bc1a2b5 into master May 16, 2023
14 checks passed
@davidgamez davidgamez deleted the docs/update-web-service-readme branch May 16, 2023 01:43
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.

None yet

3 participants