Skip to content

Commit

Permalink
docs: update description
Browse files Browse the repository at this point in the history
  • Loading branch information
thuongtruong109 committed Jul 12, 2024
1 parent c0eb7a4 commit ffdc0c4
Show file tree
Hide file tree
Showing 10 changed files with 161 additions and 104 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Go CI

on:
push:
branches: [ "main" ]
pull_request:
branches: [ "main" ]

jobs:

build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: '1.20'

- name: Build
run: go build -v ./...

- name: Test
run: go test -v ./...
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 Tran Nguyen Thuong <https://github.com/thuongtruong109>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
32 changes: 20 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
# MUSIC MANAGEMENT SYSTEM
# Soundlib - music management system

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/thuongtruong109/soundlib/ci.yml)
![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/thuongtruong109/soundlib)
## Preview

| ![Main Menu](/public/1.png) | ![Read data](/public/2.png) |

## Description

This is a music management system that allows you to add, delete, and search for songs. It also allows you to create playlists and add songs to them.
This is a music management system that allows you to interect and manage data through cli. Program is written in Go and uses JSON to store data. Practicing and handle usecases such as: file I/O, data structure, error handling, etc.

## Features

- Add songs
- Delete songs
- Search for songs
- Create playlists
- Add songs to playlists
- Delete songs from playlists
- Search for playlists
- Save data to JSON file
- Load data from JSON file
✅ Add/Delete/Search songs

✅ Create/Search playlists

✅ Add/Delete songs to playlists

✅ Save/Load/Read data from/to file

## Architecture

![ERD](/public/erd.png)
![ERD](/docs/erd.png)

## Installation

Expand All @@ -36,6 +40,10 @@ go run main.go

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License

[MIT](LICENSE) License © 2023-PRESENT Tran Nguyen Thuong Truong

<!-- ## References
[Read x write JSON](https://www.developer.com/languages/json-files-golang/)
Expand Down
2 changes: 1 addition & 1 deletion database/artists.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
[{"id":"1687605265053017500","name":"222"},{"id":"1687605373968689300","name":"333"},{"id":"1687606184929398800","name":"kokoh"},{"id":"1687662384549952900","name":"qqq"},{"id":"1687681372018956400","name":"fuel222"},{"id":"1720710413102935900","name":"test"}]
[{"id":"1687605265053017500","name":"222"},{"id":"1687605373968689300","name":"333"},{"id":"1687606184929398800","name":"kokoh"},{"id":"1687662384549952900","name":"qqq"},{"id":"1687681372018956400","name":"fuel222"},{"id":"1720710413102935900","name":"test"},{"id":"1720803919206864100","name":"Single"}]
185 changes: 94 additions & 91 deletions docs/erd.drawio

Large diffs are not rendered by default.

Binary file added docs/erd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
Binary file added public/1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added public/2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed public/erd.png
Binary file not shown.

0 comments on commit ffdc0c4

Please sign in to comment.