bperlik / blocipedia

A social, markdown wiki app that lets users create their own wikis and share them publicly or privately with other collaborators

Blocipedia

Blocipedia is a Ruby on Rails application that allows users to create wikis and collaborate on other wikis. Users can pay to upgrade their membership, allowing them to create private wikis and select collaborators.

The app is deployed on Heroku:

The source code is here on GitHub: https://github.com/bperlik/Blocipedia

This app was created as part of the Bloc Software Development Track.

Features

• Users can create a standard account in order to create, edit, and collaborate on public wikis using Markdown syntax. Anyone can view public wikis.
• Users can pay to upgrade their account to Premium in order to view and create private wikis.
• Premium users can allow others to view and collaborate on the private wikis they create.
• Premium users can downgrade their account back to Standard.
• When a user downgrades his or her account, his or her private wikis will automatically become public.

Setup and Configuration

Languages and Frameworks: Ruby on Rails and Bootstrap

Ruby version 2.3.4

Databases: SQLite (Test, Development), PostgreSQL (Production)

Development Tools and Gems include:

• Devise for user authentication
• SendGrid for email confirmation
• Redcarpet for Markdown formatting
• Pundit for authorization
• Stripe for payments

Setup:

• Environment variables were set using Figaro and are stored in config/application.yml (ignored by git).

• The config/application.example.yml file illustrates how environment variables should be stored.

To run Blocipedia locally:

• Clone the repository
• Run bundle install
• Create and migrate the SQLite database with rake db:create and rake db:migrate
• Start the server using rails server
• Run the app on localhost:3000