CONTRIBUTING.md

🤝 Contributing to Wora

Thank you for considering contributing to Wora! 🎉 We welcome contributions from everyone. We have prepared some guidelines for you to get started ✅

🛠️ Project Setup

Wora is an Electron app built with Next.js and TailwindCSS, using BetterSQLite3 with Drizzle ORM for database management. Here's an overview of the database schema:

erDiagram
    settings {
        int id
        string name
        string profilePicture
        string musicFolder
    }

    songs {
        int id
        string filePath
        string name
        string artist
        int duration
        int albumID
    }

    albums {
        int id
        string name
        string artist
        int year
        string coverArt
    }

    playlists {
        int id
        string name
        string description
        string coverArt
    }

    playlistSongs {
        int playlistId
        int songId
    }

    albums ||--|{ songs : ""
    playlists ||--o{ playlistSongs : ""
    songs ||--o{ playlistSongs : ""

🎯 How to Contribute

Once you get hold of the DB, please check out the file structure in the main branch to get yourself more familiar with the project. If you encounter any issues, support for developers is available through our discord server 🛠️

1. Fork the Repository

Fork the repository and clone it locally:

git clone https://github.com/your-username/wora.git
cd wora

2. Create a New Branch

Create a new branch for your feature or bugfix:

git checkout -b feature-branch

3. Install Dependencies

Install the required dependencies:

yarn install

4. Start Development Server

Run the development server to see your changes:

yarn dev

5. Commit Your Changes

Commit your changes with a meaningful message:

git commit -am 'Add new feature ✅'

6. Push to Your Branch

Push the changes to your branch on GitHub:

git push origin feature-branch

7. Create a Pull Request

Go to the original repository on GitHub and create a new pull request. Please also read our Code of Conduct to understand the expectations for behavior within our community 🙏

💬 Join the Community

Join our Discord server to connect with other users and developers 🤝

---

MIT License. Made with ❤️ by hiaaryan and contributors.