Skip to content

DiamondNotCrush/dnc-web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DnC Media - Web Edition

Team

  • Product Owner: Chris Griffis
  • Scrum Master: Owen Dismuke
  • Development Team: Chris Griffis, Ken Kim, Nate Parrish, Owen Dismuke

Table of Contents

  1. Project Overview
  2. Usage
  3. Requirements
  4. Development
    1. Installing Dependencies
    2. Start Grunt

Project Overview

Dnc Media is an open-source cloud solution for storing and accessing your music and movies. The project has 3 parts:

  1. Client Server

  2. Web Server

  3. Mobile App

The client server is installed on the user's computer that has access to all of their media. The user can easily sign up, log in and quickly do all the necessary setup needed to begin streaming their movies and music from the web or mobile app.

The web server is used to store the user information and act as the "single-source-of-truth" for all authentication requests. A user can also use the web server to access their media when away from their main computer.

The mobile app is just another easy way for a user to access their files.

Usage

This repo contains the web client for DnC Media. The web client acts as the API for all necessary user actions (ie. login/authentication, signup, client connection validation, etc.) The web client is written in javascript on a Node.js/Express/MySQL backend and Angular.js for the front-end. This client will run on any server that supports Node.js and MySQL.

Requirements

The only requirements to run this client are a server that can support Node.js and a MySQL database. There will be some hardcoded API calls from the client server and mobile app that will need to be changed to the new URL of this web client.

Development

Installing Dependencies

To install dependencies, for this client, run npm install. The web server was written using node v0.12.2 and MySQL version 5.5.

Start Grunt

Make sure you already have grunt-cli and the project dependencies installed. Type grunt to minify, concat, and uglify css and js. If you are performing active development, type grunt watch to have grunt automatically perform these tasks whenever you save a change.