Skip to content

Update README.md - #61

Merged
Solian21 merged 1 commit into
mainfrom
all/readme
Oct 25, 2026
Merged

Solian21 merged 1 commit into
mainfrom
all/readme

Conversation

@annabelleb20

Copy link
Copy Markdown
Collaborator

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.

@Yooze0x4c8 Yooze0x4c8 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

It's great!

@Solian21 Solian21 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

This looks amazing! Thank you for working on this Annabelle!

@Solian21
Solian21 merged commit f667d38 into main Oct 25, 2026
4 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.

3 participants