GitHub best practices with Evo + Android + Arduino

[josephshirk]

Is there a best practices guide for setting up GitHub that accommodates the various locations for EvoThings, Android, Cordova files and Arduino sketches? It's a bit confusing - there's so much stuff installed all over my drive, and I'm not sure what's aware of what. At least I'd like to set up a github repo that ties all the pieces of a project logically together.

Suppose I want to start with evothings/cordova-ble for Android only. Somewhere there has to be a sketch to go with it. What should the development cycle look like when working on the app and sketch concurrently?

I want to set it up with a mind for the future, so that it will not become a nightmare when experimenting with adding meteor-cordova-ble, or maybe replacing node.js with io.js, etc.

[micke]

What about somethings like this (assuming the Cordova app folder is called "app" for simplicity):

Code: Select all

project
  arduino
    (Arduino files)
  app
    www
      index.html
      (other files, JS/CSS etc)

It is a good thing to have a .gitignore file that filters out files that should not be on GitHub. Depending in your preferences you might not want to have the generated Android project on GitHub, for example.

This guide discusses how you can work with Cordova and Evothings:

http://evothings.com/cordova-starter-kit/

You can basically drag and prop "index.html" into Evothings Workbench and use Evotings Client when developing (assuming that you do not need any plugin not included with Evothings Client).

Does this help/make sense for your project?

Best, Mikael

[micke]

What should the development cycle look like when working on the app and sketch concurrently?

You can code the app and the Arduino sketch in parallel. Use the Workbench and a text editor for the app and the Arduino IDE for the sketch.

Does this makes sense?

If you plan to add a server using node.js or io.js, add another folder called "server" for instance to the GitHub repository folder. There put the server application JavaScript files and any node.js modules. The actual node.js/io.js installation would not go into GitHub, this would be impractical in my view.

Another options is to use multiple GitHub repositories. One for the app, one for Arduino and one for the server. GitHub repositories a re just folders really on your local machines. But it is good to have things in one repository if they are dependent. It is a matter of taste and the scope of the project which you would choose.

Best, Mikael

[josephshirk]

Thank you so much. this looks like a start in the right direction.