tabris/music-collection
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Finishing README.md
All checks were successful
Music Collection CI Workflow / test (./backend) (push) Successful in 37s
Details
Music Collection CI Workflow / test (./frontend) (push) Successful in 39s
Details
Music Collection CI Workflow / build-and-push-images (./backend/Dockerfile, git.anatid.net/tabris/music-collection-backend, ./backend) (push) Successful in 53s
Details
Music Collection CI Workflow / build-and-push-images (./frontend/Dockerfile, git.anatid.net/tabris/music-collection-frontend, ./frontend) (push) Successful in 1m55s
Details
Music Collection CI Workflow / deploy (push) Successful in 24s
Details

Browse Source
This commit is contained in:
Phill Pover 2025-04-07 12:43:51 +01:00
parent 598132fe36
commit 7a086b7575
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -90,3 +90,19 @@ networks:
external: false
frontend:
external: false
## Repository
The code can be found at [https://git.anatid.net/tabris/music-collection](https://git.anatid.net/tabris/music-collection), and is continuously deployed to the Docker network on commit by a pipeline Runner.
## Improvements
As this was very much a "learn as I went" project, there are many things that can be improved.
- Test coverage is low, covering some basic API functions in Album.Service and Album.Controller.
- The Pages in the NextJS app are mammoth, as I hadn't gotten to grips with NextJS's Components features. Splitting the Modal, Toast messages and other function handling to components would be where I concentrate next.
- Adding a User module, as well as Authentication, and reworking the Albums and Songs to be owned by each User would allow for multiple Users to maintain their own collections.
- Swagger Docs aren't quite complete, as they don't show the format of the Body in POST and PUT requests.
- Running locally in a development environment was not working for me easily, so I relied on the CI/CD pipelines to test and deploy the application during development. This probably cost more time than it saved as I've seen both NestJS and NextJS can recompile on the fly for rapid development.
- The CSS and Layout were put together in a rush and I'd like to spend more time on this aspect of the design, adding in the ability to upload Album artwork to display on the Album detail page.
## Final Thoughts
Overall, I enjoyed this project, and would happily continue to develop both it and my skills in NestJS and NextJS in the future. Due to my lack of experience with these Frameworks, and the limited time I had to complete the work, I feel I struck a good balance between achieving the brief, and showing off my strong infrastructure skills.