Skip to content

ortwic/song-repo

Repository files navigation

My song repertoire

logo

About the project

![Product Name Screen Shot][public/images/songlist.png]

An app for musicians to keep an overview of their personal song repertoire.

Do you occasionally forget which song you could play? Would you like to share your repertoire with friends? Or do you just want to keep track of your progress and know which song you could refresh? Then this app is right for you to keep an overview.

Features

  • Create personal song list
  • Manage your learning progress
  • Custom tags to note your features
  • Search song data: genre, key, tempo, lyrics, tutorials
  • Share or export list to CSV, XLSX, PDF, JSON
  • Integrated blog with useful articels on how-to make music
  • Public event calendar for Open Piano or Play Me I'm Yours

Built With

  • Svelte
  • Typescript
  • Tabulator

Hosting

Firebase: deploy to another site

firebase init

firebase target:apply hosting beta song-repo-beta
firebase target:apply hosting prod song-repo

firebase deploy --only hosting:beta
firebase deploy --only hosting:prod

(back to top)

Getting Started

Prerequisites

You should install nodejs and pnpm. I'd recommend Visual Studio Code for developing.

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

  1. Clone the repo
    git clone https://github.com/ortwic/song-repoe.git
  2. Install NPM packages
    pnpm install
  3. Start app in debug mode
    pnpm dev

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

  • Add tabulator component
  • Firestore persistance
  • Auth with email/pwd or Google account
  • CI/CD and unit tests
  • Song name suggestion API
  • Manage genres, artists, etc.
  • Share song list
  • Dark skin
  • Kanban board view

(back to top)

Contributing

Really? This project is very small yet. Contact me if you really desire...

License

Distributed under the BSD 3-Clause License. See LICENSE for more information.

(back to top)

Contact

Ortwin - Portfolio - ocsoft42@gmail.com

Project Link: https://github.com/ortwic/song-repo

(back to top)

Acknowledgments

(back to top)