From 4041c708e815a377b9f144fa877336b54a98a9c8 Mon Sep 17 00:00:00 2001 From: Digital Raven Studio Date: Sat, 27 May 2023 04:22:26 +0200 Subject: [PATCH 1/3] Added Docker support --- Dockerfile | 11 +++++++++++ Installation.md | 21 +++++++++++++++++++++ README.rdoc | 4 ++++ 3 files changed, 36 insertions(+) create mode 100644 Dockerfile create mode 100644 Installation.md diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..b5df3d9 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,11 @@ +FROM ruby:2.2.1 + +WORKDIR /opt/Launchpad + +COPY . . +RUN bundle install \ + && ruby bin/rake db:migrate RAILS_ENV=development + +ENTRYPOINT ["ruby"] +CMD ["bin/rails", "server", "-b", "0.0.0.0"] +EXPOSE 3000/tcp diff --git a/Installation.md b/Installation.md new file mode 100644 index 0000000..37e1989 --- /dev/null +++ b/Installation.md @@ -0,0 +1,21 @@ +# Installation + +## Install on Docker + +The easiest way to install the Launchpad on your won server is by using docker. + +```bash +# First, clone the repository +git pull https://github.com/Dan12/Launchpad.git +cd Launchpad + +# Next, prepare and build the Image +docker build -t launchpad:master + +# Now you can run your image like any other and enjoy the launchpad! +docker run \ + --name launchpad \ + --detach \ + -p 3000:3000 \ + launchpad:master +``` diff --git a/README.rdoc b/README.rdoc index 0e3c3b4..8edb951 100644 --- a/README.rdoc +++ b/README.rdoc @@ -20,6 +20,10 @@ Features: * Front-end written in complete JS with Ruby on Rails for the back-end, a few ajax requests to backend for information +Installation: + +* Follow the {Installation guide}[Installation.md] + TODO: * Downloadable offline version, probably zipped JS, CSS, HTML, and audio files, will have to get rid of server calls From c2d39d0c273100555b2b43974cbf668b29c4d06e Mon Sep 17 00:00:00 2001 From: Digital Raven Studio Date: Sat, 27 May 2023 04:28:03 +0200 Subject: [PATCH 2/3] Updated README --- Installation.md | 21 --------------------- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ README.rdoc | 31 ------------------------------- 3 files changed, 47 insertions(+), 52 deletions(-) delete mode 100644 Installation.md create mode 100644 README.md delete mode 100644 README.rdoc diff --git a/Installation.md b/Installation.md deleted file mode 100644 index 37e1989..0000000 --- a/Installation.md +++ /dev/null @@ -1,21 +0,0 @@ -# Installation - -## Install on Docker - -The easiest way to install the Launchpad on your won server is by using docker. - -```bash -# First, clone the repository -git pull https://github.com/Dan12/Launchpad.git -cd Launchpad - -# Next, prepare and build the Image -docker build -t launchpad:master - -# Now you can run your image like any other and enjoy the launchpad! -docker run \ - --name launchpad \ - --detach \ - -p 3000:3000 \ - launchpad:master -``` diff --git a/README.md b/README.md new file mode 100644 index 0000000..967c534 --- /dev/null +++ b/README.md @@ -0,0 +1,47 @@ +# README + +This website is an attempt to recreate a MIDI controller using the keyboard. Basically, an online launchpad, similar in function to that of Novation's Launchpad. + +## Features: + +- Uses Howler JS audio library for quick and easy audio playing across multiple browsers: http://goldfirestudios.com/blog/104/howler.js-Modern-Web-Audio-Javascript-Library + +- Uses the Zip.js library to parse .zip files: https://gildas-lormeau.github.io/zip.js/ + +- First of the Year Eqninox by Skrillex sounds, obtained from Nev's project file: https://www.youtube.com/watch?v=SAXpBgkXt60 + +- Editor Capable of recording and playing back keyboard inputs at varying playback speeds + +- Able to load and save songs to a database, only available to those who have registered an account which can only be done from the console + +- mySql test database and Postgres production database + +- Hosted on Heroku with free hobby plan + +- Front-end written in complete JS with Ruby on Rails for the back-end, a few ajax requests to backend for information + +## Installation + +The easiest way to install the Launchpad on your won server is by using docker. + +```bash +# First, clone the repository +git pull https://github.com/Dan12/Launchpad.git +cd Launchpad + +# Next, prepare and build the Image +docker build -t launchpad:master + +# Now you can run your image like any other and enjoy the launchpad! +docker run \ + --name launchpad \ + --detach \ + -p 3000:3000 \ + launchpad:master +``` + +## TODO: + +- Downloadable offline version, probably zipped JS, CSS, HTML, and audio files, will have to get rid of server calls + +- Finish editor tools and put recorded parts of songs on main page diff --git a/README.rdoc b/README.rdoc deleted file mode 100644 index 8edb951..0000000 --- a/README.rdoc +++ /dev/null @@ -1,31 +0,0 @@ -== README - -This website is an attempt to recreate a MIDI controller using the keyboard. Basically, an online launchpad, similar in function to that of Novation's Launchpad. - -Features: - -* Uses Howler JS audio library for quick and easy audio playing across multiple browsers: http://goldfirestudios.com/blog/104/howler.js-Modern-Web-Audio-Javascript-Library - -* Uses the Zip.js library to parse .zip files: https://gildas-lormeau.github.io/zip.js/ - -* First of the Year Eqninox by Skrillex sounds, obtained from Nev's project file: https://www.youtube.com/watch?v=SAXpBgkXt60 - -* Editor Capable of recording and playing back keyboard inputs at varying playback speeds - -* Able to load and save songs to a database, only available to those who have registered an account which can only be done from the console - -* mySql test database and Postgres production database - -* Hosted on Heroku with free hobby plan - -* Front-end written in complete JS with Ruby on Rails for the back-end, a few ajax requests to backend for information - -Installation: - -* Follow the {Installation guide}[Installation.md] - -TODO: - -* Downloadable offline version, probably zipped JS, CSS, HTML, and audio files, will have to get rid of server calls - -* Finish editor tools and put recorded parts of songs on main page From ef074faf38a449cedc6dd18e691a303b76ac7d28 Mon Sep 17 00:00:00 2001 From: Mazoku Date: Thu, 26 Oct 2023 16:30:51 +0200 Subject: [PATCH 3/3] docs: change repo URL for easier deployment --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 967c534..0995162 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ The easiest way to install the Launchpad on your won server is by using docker. ```bash # First, clone the repository -git pull https://github.com/Dan12/Launchpad.git +git pull https://github.com/mazowo/Launchpad.git cd Launchpad # Next, prepare and build the Image