r/p5.js-web-editor
1
0
Fork 0
Code Issues 1 Pull requests Releases 1 Wiki Activity
p5.js-web-editor/developer_docs/installation.md
Ruben van de Ven 07c4f9e899 Info for installation
2020-11-02 15:11:27 +01:00

4.6 KiB
Raw Blame History

Development Installation

Follow these instructions to set up your development environment, which you need to do before you start contributing code to this project.

Manual Installation

Note: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use copy instead of cp.

  1. Install Node.js. The recommended way is to Node through nvm. You can also install node.js version 12.16.1 directly from the Node.js website.

  2. Clone this repository using git onto your local computer.

    $ git clone https://git.rubenvandeven.com/r/p5.js-web-editor/

  3. If you are using nvm, run $ nvm use to set your Node version to 12.16.1

  4. Navigate into the project folder and install all its necessary dependencies with npm.

    $ cd p5.js-web-editor
$ npm install

  5. Install MongoDB and make sure it is running

  6. $ cp .env.example .env

  7. (For DigitalPlayground) use provided .env file

  8. Run npm run build:server && npm run build:client to make sure all script are built and bundled.

  9. use the provided service file to start the server through systemd

  • edit p5.js-web-editor.service so it has the right files & folders according to you installation
  • cp /home/dp/p5.js-web-editor/p5.js-web-editor.service /etc/systemd/system/
  • systemctl deamon-reload
  • systemctl start p5.js-web-editor.service
  1. (Optionally) Set the PORT and NODE_PORT variables in the p5.js-web-editor.service and .env files to the desired port OR use an apache server (or something else) as https-proxy server. For an example see digitalplayground-apache.conf.

Docker Installation

Note: The installation steps assume you are using a Unix-like shell. If you are using Windows, you will need to use copy instead of cp.

Using Docker, you can have a complete, consistent development environment without having to manually install dependencies such as Node, Mongo, etc. It also helps isolate these dependencies and their data from other projects that you may have on the same computer that use different/conflicting versions, etc.

Note that this takes up a significant amount of space on your machine. Make sure you have at least 5GB free.

  1. Install Docker for your operating system
  2. Clone this repository and cd into it
  3. $ docker-compose -f docker-compose-development.yml build
  4. $ cp .env.example .env
  5. (Optional) Update .env with necessary keys to enable certain app behavoirs, i.e. add Github ID and Github Secret if you want to be able to log in with Github.
  6. $ docker-compose -f docker-compose-development.yml run --rm app npm run fetch-examples

Now, anytime you wish to start the server with its dependencies, you can run:

  1. $ docker-compose -f docker-compose-development.yml up
  2. Navigate to http://localhost:8000 in your browser

To open a terminal/shell in the running Docker server (i.e. after docker-compose up has been run):

  1. $ docker-compose -f docker-compose-development.yml exec app bash -l

If you don't have the full server environment running, you can launch a one-off container instance (and have it automatically deleted after you're done using it):

  1. $ docker-compose -f docker-compose-development.yml run app --rm bash -l

S3 Bucket Configuration

Note that this is optional, unless you are working on the part of the application that allows a user to upload images, videos, etc. Please refer to the following gist to set up an S3 bucket to be used with this project.

If your S3 bucket is in the US East (N Virginia) region (us-east-1), you'll need to set a custom URL base for it, because it does not follow the standard naming pattern as the rest of the regions. Instead, add the following to your environment/.env file, changing BUCKET_NAME to your bucket name. This is necessary because this override is currently treated as the full path to the bucket rather than as a proper base url: S3_BUCKET_URL_BASE=https://s3.amazonaws.com/{BUCKET_NAME}/

If you've configured your S3 bucket and DNS records to use a custom domain name, you can also set it using this variable. I.e.:

S3_BUCKET_URL_BASE=https://files.mydomain.com

For more information on using a custom domain, see this documentation link:

http://docs.aws.amazon.com/AmazonS3/latest/dev/VirtualHosting.html#VirtualHostingCustomURLs