Clone or download
#1 Compare This branch is 3 commits ahead of kw23085:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Screenshots
config
models
public
routes
views
.gitignore
README.md
package-lock.json
package.json
server.js
sketchy-img.png

README.md

Sketchy

--

Screenshot of index

Brief Description

A sketch app where you make a drawing/sketch based off a random prompt. This image can be saved, edited, and deleted.

MVP: Basic CRUD app for sketches

Dream App: An app where you can play telephone pictionary and have a hilarious time.

--

Explanation of Technologies Used

Backend:

  • Node.js
  • Packages: Express, Mongoose, EJS Layouts, Bcrypt, body-parser, connect-flash, MongoDB, cookie-parser, dotenv, morgan, passport-local, passport-google-oauth2

Front-End:

  • JavaScript
  • HTML
  • jQuery
  • Bootstrap

--

Planning Docs

Screenshot of ERD

Screenshot of ERD

Screenshot of wireframe Screenshot of wireframe

--

--

Approach Taken

1. Lots of Planning

After deciding on our project, we spent the first night reading through documentation so we could appropriately split up the work without interrupting each other too much.

Our Trello board helped immensely with this:

https://trello.com/b/H47azMkh

2. We executed the simple stuff first

In the first day, we were able to complete the basics of our app including login, a user model and a sketch model. We also had a working canvas for drawing.

3. Communication and Daily Stand-ups

After we completed the foundation, the rest of the project was a bit more complex. We broke up the pieces into smaller parts and worked together to figure out complex bugs.

4. Polish

Once we had most of our MVP complete, we did a lot of testing to find bugs and correct them and finalize issues.

--

Major Hurdles & Victories

  • Staying on top of merge conflicts
  • Fixing the edit and update bugs

--

If we had more time:

  • Make code more DRY and clean
  • Add canvas edit
  • Add web sockets for playing pictionary
  • Reveal the giphy photo after
  • Add more dream features (see Trello ICE board) __

Installation Instructions

For easy-start, go to this heroku app: http://sketchyapp.herokuapp.com/

To run this app, locally, you will need to register for your own API keys and do these following steps:

  1. Fork it over to your git hub.

  2. Do a git clone in your terminal from your github.

  3. Add a .env file to your root of your application.

  4. Get an APIKEY from Giphy

  5. Get a Client ID and Client secret from Google Developers API

  6. API keys should have no space in them. Use these

  1. Run npm install to install all packages
  2. Open up a new tab and run $mongod (If you don't already have Mongo, you will need to do a brew install)
  3. Open up another new tab and run $nodemon (If you don't already have Nodemon, you will need to do a brew install)
  4. Save your code and enjoy Sketchy!

--