Is there an example of how to create a repository for a portfolio?

Question

Portfolio

Is there an example of how to properly design a repository for a portfolio, attach an application screen there, is it necessary to describe what was used, etc.?

Answer 1

1. Do everything you can in a turnip. That is, for example, tests, configured ci / cd, and so on.
Badges indicating that the tests passed/failed
2. Completely describe the project, what it is, and how to deploy it on your own. Ideally, some automated script (for example, via Docker)
3. Add screenshots and a link to the demo, if possible.
4. If the project is complex, then write documentation about what and where is there.
5. Naturally, describe in a separate section all the technologies used, and what they were used for.

Answer 2

It makes no sense to design a repository as a portfolio.
Or, in principle, you run some hobby projects and store them in a public repository such as github - in this case, you will comb the repository yourself, add all sorts of readme there just to make it clear what it is and why.
And throwing there test things that you did especially for the interview - well, this is ...