Skip to content

Latest commit

 

History

History
105 lines (70 loc) · 2.15 KB

README.md

File metadata and controls

105 lines (70 loc) · 2.15 KB
Raw

Pluribus

A socal media platform built with the MERN stack: MySQL, Express, React/Redux, Node

Team

  • Product Owner: Mark Keith
  • Scrum Master: Todd Bontrager
  • Development Team: Nick Vinson

Table of Contents

  1. Usage
  2. Requirements
  3. Development
    1. Installing Dependencies
    2. Tasks
    3. Launching App
  4. Team
  5. Roadmap
  6. Contributing

Usage

Pluribus was developed to empower citizens to engage in local community issues. This is accomplished by providing users with a map-driven social media platform.

Requirements

Make sure you have installed all of the following prerequisites on your development machine:

  • Node 4.4.3
  • Express 4.13.4
  • React 15.0.2
  • Redux 3.5.2
  • Sequelize 3.22.0
  • MySQL 2.10.x
  • OAuth 2.0

Development

Installing Dependencies

From within the root directory:

npm install

Tasks

From within the /server directory:

  1. Create a bare .env file
  2. Include the secret Google OAuth Client ID, Secret and Express Session Secret like this:
GOOGLE_CID=987654321randomsomethinghere
GOOGLE_CSECRET=itsasecret
SESSION_SECRET="somethinghere"

Launching App Locally (Development)

Launch the MySQL server by running:

mysql.server start

Then create a local MySQl database called pluribus. In the command line:

mysql [OR] sudo mysql
mysql> CREATE DATABASE pluribus;

In the root folder, run:

webpack -w

In the root directory, run:

npm start

Finally, navigate to http://localhost:3000 on your web browser.

Team

  • Mark Keith
  • Todd Bontrager
  • Nicolas Vinson

Roadmap

View the project roadmap here

Contributing

See CONTRIBUTING.md for contribution guidelines.