borgnix-cloud-ide

INSTALL

The application needs Arduino IDE and Arduino-Makefile.

Install Arduino IDE by download the latest version for you platform here, then extract or install it.

Install Arduino-Makefile by clone the latest version from github with the following command:

git clone https://github.com/sudar/Arduino-Makefile.git

Install the application itself using the following command:

npm i git+https://github.com/Orientsoft/borgnix-cloud-ide.git

Check your public folder for a directory named vendor, if none exists, run:

gulp install

CONFIG

You HAVE TO change the config file before you start using the application.

Open config/config.json, replace the default values with your actual settings. Please use ABSOLUTE PATH.

1. arduinoDir: the path to you Arduino IDE, for osx the path may be /Applications/Arduino.app/Contents/Java.
2. arduinoMkDir: the path to your Arduino-Makefile directory.
3. projectRoot: the directory to store user projects.
4. uploadDir: the directory to store files uploaded by users.
5. arduinoLibs: the directory to store libraries shared by all users.
6. singleUser: whether to use single user mode or not.
7. session: sessions management options, see SESSION for details.

SESSION

config file

1. secret: secret key for sessions.
2. store: session store options.

• for redis:

{
  "type": "redis",
  "host": "localhost", //your redis host
  "port": 6379, //your redis port
  "pass": "password", //password for redis, if any
  "prefix": "sessions:" //prefix for redis keys
}

validation

See routes/auth.js and routes/single.js for details

USAGE

To start the server, run:

npm start

Then open http://127.0.0.1:3001 in your browser to use the client.

You can change the port settings in bin/www

TODO and Known Issues

• Improve UI design and details
• Show files in sub-directory in ProjectManager
• Create a new project using a template project
• User validation
• [BUG] When a project is deleted, the project select field and the editor show different project