Skip to content

NMVW/pluribus

 
 

Repository files navigation

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

Launch the MySQL server by running:

mysql.server start

Then create a MySQl table called pluribus.

In the root folder, run:

webpack -w

In the /server folder, run:

npm server.js

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.

About

Localized Twitter feed

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 99.1%
  • HTML 0.9%