Wiki Page for Peanut Gallery - Peanut-Gallery/peanutgallery GitHub Wiki

Welcome to the Peanut Gallery wiki!

Update! The site may no longer be active after a certain time. We apologize for the inconvenience.

Table of Contents

The Site:

Our project is called "Peanut Gallery".

This landing page is presented to users when they visit the top-level URL to the site.

"Peanut Gallery" is a web-based application that allows users to create and submit surveys. New users will be encouraged to go through an account creation process in which they submit their full name and email address and create a password and a bio for their profile. Upon creating an account and signing in, they will be allowed to take browse and take surveys after clicking "Search for Surveys" in the navigation bar. For now, users can specify who they are taking a survey for and provide a rating alongside a detailed review of the service. Administrators to the site will have access to modify and delete survey postings or reviews that may not fit with the site guidelines.

Our Team:

  • Sang Nguyen
  • John Hsu
  • Shawn Anthony

User Guide

This section provides a walkthrough of the Peanut Gallery user interface and its capabilities.

Landing Page

The landing page is presented to users when they visit the top-level URL to the site.

Register Page

The user can register an account if they are not already registered by clicking the 'Sign Up' option in the Nav Bar. From there, they must fill out the required fields to create an account.

Login Page

Returning users can login to the system by clicking on the 'Login' option in the Nav Bar, and inputting their email and password.

When the user is logged in, they will land on the landing page again. From there, they can select "Search for Surveys" in the Navigation Bar and begin taking surveys.

To search for the surveys that you want to take, clicking on the 'Search by Name, Author, or Company' bar will display books whose information is relevant to your search.

If there are no entries pertaining to your search, then you will be greeted by a 'No results.'

Survey

Upon finding a survey to take, you can select "Take Survey" to begin taking the surveys. As of currently, users can give their a name, image, rating, and comment. They can also specify who the review is for.

Admin Role

Users with the admin role will have access to all of the surveys and user reviews in the database. They can add surveys and also edit any preexisting items. If there is an entry that is deemed to be inappropriate, the admin can delete the entry. Admins can email the owners of these inappropriate entries and ban them for any inappropriate conduct on the site.

Administrators with also be able to view reviews to review the entries.

Developer Guide

This section provides information of interest to Meteor developers wishing to use this code base as a basis for their own development tasks.

Installation

First, install Meteor.

Second, visit the Peanut Gallery application GitHub page and click the “Use this template” button to create your own repository initialized with a copy of this application. Alternatively, you can download the sources as a zip file or make a fork of the repo. Then, download a copy of the repo to your local computer.

Third, cd into the text-realm/app directory and install libraries with:

$ meteor npm install

Fourth, run the system with:

$ meteor npm run start

If it all goes well, the application will appear at http://localhost:3000.

Initialization

The settings.development.json file is intended to hold default database settings.

This file contains default definitions for Users, Survey Entries, and Ratings/Reviews and the relationships between them.

The initial system run may not initialize the database that comes with the template. To initialize this, run the system using:

meteor run --settings settings.development.json

Quality Assurance

ESLint

TextRealm includes a .eslintrc file to define the coding style adhered to in this application. You can invoke ESLint from the command line as follows:

meteor npm run lint

ESLint should run without generating any errors.

It’s significantly easier to do development with ESLint integrated directly into your IDE (such as IntelliJ).

Information Disclaimer

Information that is collected will be hosted in a database in MongoDB. In addition, for any sensitive information that is collected, we will strive to protect their data to the best of our ability by maintaining a dynamic analysis of our program and database. If there is a data breach of any kind, we will be sure to notify the users affected of the breach and direct users to change their passwords.

The use of this application demands that racial, sexual, or any inappropriate slurs will not be tolerated, and users will be banned for illegal/inappropriate behavior.

Release Versions

v1.0

Our initial release version: https://github.com/Peanut-Gallery/peanutgallery/releases/tag/v1.0