Repository navigation
Update README.md - #61
Merged
Merged
Conversation
annabelleb20
requested review from
Solian21,
Yooze0x4c8 and
leslyVillanueva1020
as code owners
October 23, 2026 22:01
Solian21
approved these changes
Oct 25, 2026
Solian21
left a comment
Owner
There was a problem hiding this comment.
This looks amazing! Thank you for working on this Annabelle!
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
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.
Each repo needs a README.md with the project name and description, team members, tech stack, step by step local setup including Docker commands, the live API URL, and a link to the Swagger docs.
^ Those are directly from the project instructions
Feel free to leave comments, but it would probably be better to make your own changes/commits to the README. This is going on an all branch because idk I think this is a group effort.
Wasn't 100% sure what to put for the commands to run the API, so sorry if that's incorrect
Also I just copied the description for each of you guys from the slides we made, feel free to change that too.
I imagine after this is done we can basically copy and paste most of this README to the app README. Cuz we need that too.