README.md

Project - PaCaLa

Technology creates life, and Best illuminates life.


Visit the website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

(back to top)

Built With

• Three.js
• Bootstrap
• JQuery

(back to top)

Getting Started

Installation

Clone the repo

git clone https://github.com/itCarl/BlubberLoungePaCaLa.git

(back to top)

Roadmap

• Create Github repository
• [] make a 'proper' 3D model in blender or c4d
• [] Add Additional Templates w/ Examples
• [] Change name "PaCaLa" to something more creative
  • https://en.wikipedia.org/wiki/List_of_solar_deities
  • Gigawatt
  • Lightitech
  • Insta Ray
  • Positive Voltage
  • Show It Bright
• [] Add multi-language Support
  • English
  • [] German

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

(back to top)

Contributing

If you plan to submit a PR bigger than a simple change in one file, here is a short intro about how to do a clean PR. greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project locally via git clone https://github.com/<github_user>/BlubberLoungePaCaLa.git.git (replacing <github_user> with your GitHub Username) and work on your local copy
2. Add the upstream repository via git remote add upstream https://github.com/itCarl/BlubberLoungePaCaLa.git
3. Ensure you are on the master branch via git checkout master
4. Create your Feature Branch by running git checkout -b <temp_branch>
5. Set the upstream branch via git push --set-upstream origin <temp_branch>
6. Work on your local and push as many commits as you want

When you think it is ready to merge and submit a PR:

1. Return to the master branch via git checkout master
2. Ensure your master branch is up-to-date with the latest changes via git pull upstream master
3. Update your fork of this repo by running git push
4. Create a new branch to be used for your PR via git checkout -b <pr_branch>
5. Set the upstream branch via git push --set-upstream origin <pr_branch>
6. Merge the edits but be sure to remove the history of your local commits via git merge --squash <temp_branch>
7. Create a new commit containing all of your merged changes via git commit -m "<Message>"

Now you have a clean single commit from which you can create the PR on the WLED Github.

(back to top)

License

Distributed under the MIT License. See license.txt for more information.

(back to top)

Contact

BlubberLounge Team - info@blubber-lounge.de

Project Link: https://github.com/itCarl/BlubberLoungePaCaLa

(back to top)

Acknowledgments

Big Thanks to all the Projects listed below <3

• WLED an Open Source Project by Christian Schwinne
• FastLED
• Choose an Open Source License

(back to top)