shonemik/LeadShareApp

secrets

table of content

• introduction
• usage
• api
• authors
• jobs
• contribute
• repository description
• license

LeadShareApp

[back to top]

PaaS for sharing costs for google ad campaigns to get leads

usage

[back to top]

☠☠☠ section is under construction ☠☠☠

api

[back to top]

☠☠☠ section is under construction ☠☠☠

authors

[back to top]

• ninabreznik
• serapath

jobs

[back to top]

There is more jobs in the source code marked with // @TODO: <job description> and eventually some jobs might be listed under the LeadShareApp issues page, which can also be accessed through waffle.io.

• @TODO: Create a Github Page
  • https://github.com/jekyll/jekyll
  • https://help.github.com/categories/20/articles
• @TODO: Include Testing via "Specification Driven Development" using gherkin dsl & TESTEM
  • https://github.com/cucumber/cucumber/wiki/Gherkin
  • npm install mocha --save-dev
  • npm install chai --save-dev
  • https://github.com/airportyh/testem
• @TODO: Add CHANGELOG File
• @TODO: This section should instead list all the TODO-Branches currently available + a link to the "TODO Description file in that branch"
  • The README.markdown in that branch could list the description under the "jobs section"
• @TODO: add workflow description
  • http://www.wolfe.id.au/2014/02/01/getting-a-new-node-project-started-with-npm/
  • http://quickleft.com/blog/creating-and-publishing-a-node-js-module
  • http://www.devthought.com/2012/02/17/npm-tricks/

contribute

[back to top]

PREPARE SYSTEM

• install ruby on rails environment
• install git if it is not yet installed on your system
• install node if it is not yet installed on your system
• open a terminal on your system and navigate to your favourite workspace folder
  • (you might need to prefix some of the following commands with sudo to make them work)

START PREPARING LEADSHAREAPP PROJECT

• git clone https://github.com/ninabreznik/LeadShareApp.git
• npm install
• npm update
• bundle install
• rake db:migrate
• npm start & rails s
• load the APP by opening and pointing your browser to: http://localhost:3000/
  • HINT1: this might only works with CORS disabled. In order to do so:
    • mac osx open -a Google\ Chrome --args --disable-web-security
    • linux google-chrome --disable-web-security
    • windows chrome.exe --disable-web-security
  • HINT2: the server can be administrated through (e.g. localhost:3000/admin)
    • user: admin@example.com
    • pass: password

... HAPPY CODING :-)

• How to shorten feedback cycles during development (Process to use for projects, where dependencies projects have to be developed in parallel to the main project) In order to use changes made in a dependency project, they have to be commited and pushed and the version has to be increased and published. Afterwards, in the main project, the version for the updated dependency has to be adapted in package.json and npm install has to be run. That is a lot of hassle to be done for each change.

• Solution Given: "Main Project" and "Dependency Project" are both git clone'ed to the local developer machine. Process:

0. Open all those Project Folders in sublime editor and then use the terminal to...
1. Go to the "Dependency Project" repository and increase the "Version Number" in the package.json file, but don't git push.
2. Run npm link in the root directory of the "Dependency Project" repository.
3. Go to the "Main Project" repository and increase the "Version Number" of the "Dependency Project" in the package.json file.
4. Run npm link 'dependency name' in the root directory of the "Main Project" repository. That's it, execute npm start in the "Main Project" repository and start hacking...

Finishing: After all changes are done to both projects and you are satisfied with the result...

1. Go to the "Main Project" repository and run npm link 'dependency name' in the root directory.
2. Go to the "Dependency Project" repository and run npm unlink in the root directory.
3. Then git commit and git push all the changes to publish the new version.
4. Go to the "Main Project" repository and run npm install to get the new version of the dependency you just updated.

That's it.

repository

[back to top]

☠☠☠ section is under construction ☠☠☠

license

[back to top]

This work is licensed under CC BY-NC-ND 4.0.

In short - you are free to:

• Share — copy and redistribute the material in any medium or format The licensor cannot revoke these freedoms as long as you follow the license terms. Under the following terms:

• Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. NonCommercial — You may not use the material for commercial purposes.

• NoDerivatives — If you remix, transform, or build upon the material, you may not distribute the modified material. No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits. Notices:

You do not have to comply with the license for elements of the material in the public domain or where your use is permitted by an applicable exception or limitation.

No warranties are given. The license may not give you all of the permissions necessary for your intended use. For example, other rights such as publicity, privacy, or moral rights may limit how you use the material.

...more information