Skip to content

An open-source, full-stack community project inspired by Spotify, providing free access to audio streaming and sharing within the open source community.

License

Notifications You must be signed in to change notification settings

a4arpon/geetify

Repository files navigation

Knowlyric

New revelation of Audio Streaming Platform Being Started from Today, signed by Mr. Wayne and Mr. Solo

Red Alert (License)

Please check the license before modifying and distributing this project. Distributing as a proprietary or paid application is prohibited. We can take any legal action if you do this. But we are happy to say this, you're welcome to contribute Knowlyric as a open source project and share with you friends. Knowlyric is not belongs to any organization, company or person individual. It belongs to all of us. You can check full agreement License Paper

NB: কমিউনিটির জিনিস, গণ্য মান্য নেতাদের মোতো নিজের নামে চালায় দিয়েন না। যদি কন্ট্রিবিউট করতে মনচায় তাইলে এখানে ফিচার অ্যাড করে নয়তো এখানকার Repo Fork করে কাজ করিয়েন । যদি চিকনা বুদ্ধি করে রিপো ডাউনলড করে গিট ফোল্ডার ডিলিট করে নিজের নামে পুশ করেন ভাল হবে না!!!

Contribution Guide

You must need to use provided VSCode settings for code styling with eslint enabled. eslint can't be disabled. You must use provided folder structure and commit style. Only acceptable and tested changes will be allowed with proof.

If you can't contribute with code, you can contribute with us in financial way. We will be very grateful when you contribute in our community.


Folder Structure (Important):

src
|
+-- _firebase         # this folder have firebase config files.
|
+-- assets            # assets folder can contain all the static files such as images, fonts, etc.
|
+-- components        # shared components used across the entire application
|
+-- contexts          # this folder have contexts used in sites.
|
+-- layouts           # container or main layout will be here.
|
+-- hooks             # shared hooks used across the entire application
|
+-- pages             # this folder contain all pages in site.
|
+-- routes            # routes configuration
|
+-- utilities         # shared utility functions

Commit Structure (Important).

When you added any feature/ui feature commit msg must be like this:

git commit -m "Feature: Floating navbar added with user photo and name."

When you added any core feature commit msg must be like this:

git commit -m "Core: Auth provided optimized for better performance."

Another example

git commit -m "Core: SignIn with google has been added."

When you fixed any error in existing code or feature commit msg must be like this:

git commit -m "Fix: Auth provider error fixed while user new try register."

When you made any changes in docs commit msg must be like this:

git commit -m "Doc: Installation method explained more detailed way."