Repository navigation
Add detailed README with setup, usage, and API documentation, and inc… - #14
Merged
Merged
Conversation
…lude original assignment instructions - Created a comprehensive README.md for the Eventshuffle backend API. - Added project overview and purpose summary. - Documented development stack. - Included setup instructions for running the backend locally via Gradle. - Provided full API reference with example requests, responses, and single-line curl commands. - Explained data persistence using SQLite and Hibernate JPA. - Added architecture overview diagram. - Described CI workflow and design notes. - Added Future Additions section outlining potential improvements. - Added INSTRUCTIONS.md with the original Futurice assignment brief, preserving endpoint specifications and example JSON responses.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
…lude original assignment instructions