update readme.md

This commit is contained in:
geoffrey45 2022-04-09 01:21:51 +03:00
parent e23067574e
commit bf6aaea4ff
6 changed files with 44 additions and 25 deletions

View File

@ -1,5 +1,42 @@
### Alice Music
Alice is a web-based music manager (or basically a music player) that will make it easier to find and enjoy your music. Currently in the early stages of development.
Although it's quite usable, it's not quite ready for use yet. I'm working on getting done with some dev setup instructions. So, check back soon!
Assuming you won't look at those broken buttons twice, here are some screenshots of the current state of the app:
### 1. The folder page
![](./images/1.png)
`installation instructions coming soon ...`
This pages allows you to navigate through your music folders the same way you would on your computer. It doesn't show the directories without playable files. At this point, only FLAC and MP3 files are supported. (For experimenting purposes only, other formats will be added before the stable release)
### 2. The Album page
![](./images/3.png)
This page shows the album details including tracks, album artist, featured artists and Last FM album bio. The UI may look a bit rough but it will do for now.
### 3. The Playlists list page
![](./images/4.png)
This page lists all the playlists you have created. More features will be added to this page in the future. These "might" include Folders, Search, etc.
### 4. The Playlist page
![](./images/2.png)
This page shows the details of the playlist. It includes the playlist name, description, and the songs in the playlist. You can update your playlist details from this page.
### A little narration
The app features two sidebars. The one on the left and one on the right. The left sidebar is the classic navigation bar while the right sidebar acts as a quick access menu. The queue and the global search components are fixed here. Although they might switch to other locations in the future, the current position will work for now.
Here are some other functional features already implemented:
- Track context menu
- Global search (😅 buggy as fuck)
- Basic playback controls
- Queue saving on browser or page reload.
There may be a few more, but I can't remember them at the moment.
### Dev Setup
I'm working on this section. I'll be adding instructions soon. Please check back later!
### Contributing
The app runs on Python, Vue, Flask, MongoDB and Nginx. If you want to contribute, please open an issue or pull request. Your contribution is highly valued.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 553 KiB

After

Width:  |  Height:  |  Size: 331 KiB

BIN
images/2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 860 KiB

BIN
images/3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 616 KiB

BIN
images/4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 587 KiB

View File

@ -1,11 +1,8 @@
<template>
<div class="folder-top flex">
<div class="fname">
<button class="play image">
<div class="icon"></div>
Play
</button>
<div class="text">
<PlayBtnRect />
<div class="ftext">
<div class="icon image"></div>
<div class="ellip">
{{ folder.path.split("/").splice(-1).join("") }}
@ -17,6 +14,7 @@
<script setup lang="ts">
import useFStore from "../../stores/folder";
import PlayBtnRect from "../shared/PlayBtnRect.vue";
const folder = useFStore();
</script>
@ -32,30 +30,14 @@ const folder = useFStore();
.folder-top .fname {
width: 100%;
display: flex;
gap: $small;
align-items: center;
.play {
height: 100%;
width: 5em;
background-color: $blue;
padding-left: $small;
margin-right: $small;
.icon {
height: 1.5rem;
width: 1.5rem;
background-image: url(../../assets/icons/play.svg);
background-size: 1.5rem;
background-position: 10%;
margin-right: $small;
}
}
.text {
.ftext {
position: relative;
display: flex;
align-items: center;
height: 2.5rem;
border-radius: $small;
background-color: $primary;
padding: $small $small $small 2.25rem;