develop #48
Merged
develop #48
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
make run_api_dev
Feature/api specifications
Catch SIGINT in run_api_dev
Co-authored-by: riiim400th <[email protected]>
🐞 fix(#9): mock test コマンド変更
…y/charimachi into feature/api-specifications # Conflicts: # openapi-specifications/api.swagger.json
/api/v1/directions/bicycle
Without Route adjustment
Feature/api specifications
✨ feat(#36): 違反件数と違反率を表示
📃 docs: Open Data usage
📃 docs: add res open data
Feature/screenshot
📃 docs: update demo section in README and add demo GIF
Feature/api specifications
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 introduces several documentation and developer experience improvements, adds new scripts for running the API and mobile app, and updates OpenAPI references throughout the project. The most significant changes are updates to the workflow and instructions for consistency, new Makefile targets for easier development, and enhancements to API documentation and sample endpoints.
Documentation and Workflow Updates
README.md,api/README.md, and.github/copilot-instructions.mdto ensure consistency across documentation and scripts. [1] [2] [3] [4] [5] [6].github/copilot-instructions.md, including environment requirements, workflow timeouts, and manual validation scenarios. [1] [2] [3] [4] [5] [6] [7] [8] [9]Developer Experience Improvements
run_api_devfor running the Go API server with automatic Swagger UI launch, andrun_mobile_appfor starting the mobile app, streamlining local development..envtoapi/.gitignoreto prevent accidental commits of sensitive environment configuration.API Documentation and Sample Endpoints
getHealthendpoint inapi/health.gofor health checks, including Swagger documentation comments.api/main.goto load environment variables from.envusinggodotenvand refactored imports for clarity. [1] [2]README and Project Overview Enhancements
README.md, including diagrams, screenshots, and detailed descriptions of supported data sources and open data integration. [1] [2] [3] [4] [5]Dependency and Configuration Updates
github.com/google/uuidandgithub.com/joho/godotenvfor improved API functionality and configuration management.These changes collectively improve onboarding, developer workflow, API clarity, and project documentation.