Giter Club home page Giter Club logo

sample-project-proposal's Introduction

Flux-capacitr

Heroku link

Minimum Viable Product

Flux-capacitr is a clone of Tumblr built on Rails and Backbone. Users can:

  • Create accounts
  • Create sessions (log in)
  • Create blogs
  • Create blog posts
  • View blogs and posts
  • Subscribe to blogs
  • View a feed of subscribed blogs
  • Tag blog posts
  • Search for blogs by title
  • Search for posts by tag

Design Docs

Implementation Timeline

Phase 1: User Authentication, Blog Creation (~1 day)

I will implement user authentication in Rails based on the practices learned at App Academy. By the end of this phase, users will be able to create blogs using a simple text form in a Rails view. The most important part of this phase will be pushing the app to Heroku and ensuring that everything works before moving on to phase 2.

Details

Phase 2: Viewing Blogs and Posts (~2 days)

I will add API routes to serve blog and post data as JSON, then add Backbone models and collections that fetch data from those routes. By the end of this phase, users will be able to create blogs and view both blogs and posts, all inside a single Backbone app.

Details

Phase 3: Editing and Displaying Posts (~2 days)

I plan to use third-party libraries to add functionality to the PostForm and PostShow views in this phase. First I'll need to add a Markdown editor to the PostForm, and make sure that the Markdown is properly escaped and formatted in the PostShow view. I also plan to integrate Filepicker for file upload so users can add images to blog posts.

Details

Phase 4: User Feeds (~1-2 days)

I'll start by adding a feed route that uses the current_user's subscribed_blogs association to serve a list of blog posts ordered chronologically. On the Backbone side, I'll make a FeedShow view whose posts collection fetches from the new route. Ultimately, this will be the page users see after logging in.

Details

Phase 5: Searching for Blogs and Posts (~2 days)

I'll need to add search routes to both the Blogs and Posts controllers. On the Backbone side, there will be a SearchResults composite view has BlogsIndex and PostsIndex subviews. These views will use plain old blogs and posts collections, but they will fetch from the new search routes.

Details

Bonus Features (TBD)

  • "Like" button and counter for posts
  • Custom blog urls
  • Pagination/infinite scroll
  • Activity history (e.g. likes, reblogs, taggings)
  • Post types (image posts, quote posts, etc)
  • Reblogging
  • Multiple sessions/session management
  • User avatars
  • Typeahead search bar

sample-project-proposal's People

Contributors

rglassett avatar

Watchers

Phoenix Eliot avatar James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.