d48/mytestimony

Web application to share testimonies about God

 __    __     __  __     ______   ______     ______     ______   __     __    __     ______     __   __     __  __    
/\ "-./  \   /\ \_\ \   /\__  _\ /\  ___\   /\  ___\   /\__  _\ /\ \   /\ "-./  \   /\  __ \   /\ "-.\ \   /\ \_\ \   
\ \ \-./\ \  \ \____ \  \/_/\ \/ \ \  __\   \ \___  \  \/_/\ \/ \ \ \  \ \ \-./\ \  \ \ \/\ \  \ \ \-.  \  \ \____ \  
 \ \_\ \ \_\  \/\_____\    \ \_\  \ \_____\  \/\_____\    \ \_\  \ \_\  \ \_\ \ \_\  \ \_____\  \ \_\\"\_\  \/\_____\
  \/_/  \/_/   \/_____/     \/_/   \/_____/   \/_____/     \/_/   \/_/   \/_/  \/_/   \/_____/   \/_/ \/_/   \/_____/

Overview

This is a website to help people share about their tesimony of what God has done in their life. This is specifically for people that follow Jesus Christ and would like others to know of how Jesus has changed their lives. Online tools will be provided to:

1. Aid people on how to set up or write a testimony. Example: an outline and how many words to keep it within so as to help put it down.
2. Easy to use website to help create testimony and save online. Easy for anyone old enough to type and read.
3. Tools to share easily via email and text. Example: short URLs and share utility to social networks.
4. Can set testimony to be viewed publicly and anonymously so that search engines can pick up on keywords that may help others in their struggles and see how God helped and changed their lives.

View temporary working website on Heroku

Note: preview environment unavailable. Review images below.

Run the app locally with Vagrant

• Requirements
  • Virtualbox - [https://www.virtualbox.org/]
  • Vagrant - [https://docs.vagrantup.com/v2/installation/index.html]

Once Virtualbox and Vagrant are installed you just need to clone this repo and run vagrant up. Vagrant will take care of installing the necessary dependencies and loading the app.

$ git clone https://github.com/d48/mytestimony.git
$ cd mytestimony
$ vagrant up

Now you should see the app at http://localhost:4000

Technology

• Overview
• MongoDb usage

How to configure/install and run locally

• Requirements
  • Node.js
  • MongoDB

Once the above is installed, clone this repo and run npm install to donwload and install node library dependencies

$ git clone git@github.com:d48/mytestimony.git && cd mytestimony
$ npm install

To start app, run the following and open web browser at http://localhost:4000

$ make startapp

To stop app

$ make stopapp

Initial Designs

Homepage - one page app

Homepage - Share Testimony

Colored

Diagrams

Create Testimony flow

For launch with no user accounts

Post launch with user accounts

Database setup

From Wiki

RESTful API

View architecture and details here: https://docs.google.com/document/d/1DmooeXBQrIVdDpkACxRuvmMi2VNw3Ht8d2x5o9OHRO0/edit

Roadmap

• paste youtube link to pull up video thumbnail
  • or ability to upload their own testimonial video
• ability to post up their own audio testimony
• Overview of who, what, where, how
• Wireframes for main application for creating and list of tesimony view
  • Create page
    • Design testimony detail page
  • List of random testimonials
  • Edit page
    • insert testimony into db upon passing validation
    • Preview button will iterate on this for future version
    • Idea of now having testimony form be multi-steps with option for user to provide email to have generated link for safe keeping
  • Browse tag results [in progress]
  • Login modal
  • Register form
  • Account settings
• setting up aws ec2 instance to have git deploy to it upon commits
  • convoluted to set up the instance
  • following blog post http://thefloppydisk.wordpress.com/2013/04/25/a-node-js-application-on-the-amazon-cloud-part-1-installing-node-on-an-ec2-instance/
• installed node and npm
• configured base node app, request not resolving. need to troubleshoot
  • user is specific for ssh ssh -i mythosts.pem ec2-user@ec2-54-213-215-238.us-west-2.compute.amazonaws.com
  • to run node.js continually, installed forever module: https://github.com/nodejitsu/forever
  • looking to instlaling new instance of mongodb instead of configuring from marketplace.
  • new Url: http://ec2-54-186-24-182.us-west-2.compute.amazonaws.com or http://54.186.24.182/
• move Single Page Application model
  • reading tech talk of medium.com setup: https://medium.com/tech-talk/fb44da86dc1f
  • no page refreshes
  • streamline content loading (lazy loading, scroll to bottom and load more), look at http://artsy.net
    • vid of browsing through with loaders, modals, and content fades: http://screencast.com/t/VyrULmZL9m2u
  • streamline editor, look at http://www.medium.com
    • vid of browsing and using editor to create a post: http://www.screencast.com/t/wKkNX88hQGwl
• Authentication
  • Set up passwordless authentication that hooks into email: http://blog.design48.net/2014/04/15/passwordless-authentication/
• Creating Testimony
  • idea from Jacin about Zemanta for auto-tagging and suggestions
  • http://demo.zemanta.com/
  • 
• Search
  • by author, tag, date, username, etc
• Timeline
  • view specific user timeline and testimonies based on date specified in testimony
  • user/testimony linking with approval process
• Poster and visitor engagement
  • have poster inspired by comments, likes, shares
  • may not have comments so as to control spam and having to control
• FAQ / About
  • Will link to this once live: https://d48.gitbooks.io/mytestimony/content/

Todo

• Start rolling out mocha tests
  • hook in zombie.js or phantom.js to mock in DOM
• Integrate jsdoc3 lib and throw in doc directory. To build on every post-commit or set up watch on changes to .js file
  • Start looking into grunt for build/deploy scripts
• Look into postmark.js and wrapper for api https://github.com/voodootikigod/postmark.js
  • look into general smtp service via node
• sanitization on client side and server side form submission
  • HTML escaping from user supplied input (especially formatted testimony)
  • insert tags and remove duplicates
• client side validation of form
  • make more robust
• look into glue.js for CommonJS modules for the browser for modularizing code
  • http://mixu.net/gluejs/
• share feature
  • ux design to have button open up div with options
• CI
  • look into http://ci.testling.com/
  • connect to ci and continuous deployment environment
• Security
  • https://speakerdeck.com/ckarande/top-overlooked-security-threats-to-node-dot-js-web-applications
  • CSRF for forms here: http://scottksmith.com/blog/2014/09/04/simple-steps-to-secure-your-express-node-application
  • look into node lib for common security issues to apply for express middleware: https://github.com/evilpacket/helmet
• Modules
  • browserify nope, adds to much overhead
  • requirejs
  • breaking up js into modules for client in progress
• Crypto
  • use native crypto lib to create custom hash for edit string that will be used as link for editing specific testimony
  • this will be enabled once smtp server setup to send out email to confirm for user if they want to publish testimony
  • use of hashid: https://github.com/ivanakimov/hashids.node.js/issues/1
• Tags
  • bug: on testimony form, adding tag for 6:38 doesn't take once press enter key.
• DB
  • manage db solution apart from github
• Text share feature
  • created twilio account. See how to integrate share feature to send text message with short url to testimony
• shortID
  • update local db instance for temp shortId to using shortId lib
• Short URL service
  • Find 3rd party service or build one
• Setup cluster
  • use cluster module to setupMaste and fork() so can scale
  • http://rowanmanning.com/posts/node-cluster-and-express/
• Design
  • create mood board: http://lai.github.io/rendevo.html
• Animation
  • Use this lib for fade ins: https://daneden.github.io/animate.css/