mikelbrierly/halogen

A web based application to add better lighting to video calls.

---

Running locally

1. Fork this repository

2. Copy repo URL for cloning

3. Clone

  git clone https://github.com/developer-delta/halogen.git

4. cd into the halogen directory

  cd halogen

5. Make sure you have your IDE install

Visual Studio Code is recommended

For Visual Studio Code users

Here is the launch.json configuration for running the server and the client simultaneously

{
  // Use IntelliSense to learn about possible attributes.
  // Hover to view descriptions of existing attributes.
  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
  "version": "0.2.0",
  "configurations": [
    {
      "type": "node",
      "request": "launch",
      "name": "Server",
      "runtimeExecutable": "${workspaceFolder}/node_modules/nodemon/bin/nodemon.js",
      "program": "${workspaceFolder}/server/index.js",
      "outputCapture": "std"
    },
    {
      "type": "pwa-chrome",
      "request": "launch",
      "name": "Client",
      "preLaunchTask": "npm: client",
      "url": "http://localhost:3000",
      "webRoot": "${workspaceRoot}/client/src",
    }
  ],
  "compounds": [
    {
      "name": "Server and Client",
      "configurations": ["Server", "Client"]
    }
  ]
}

---

Looking to contribute?

If you'd like to help build halogen, head over to the contributing guidelines page.

This is a great place to start with open source! 🍻