Giter Club home page Giter Club logo

segcapstone's Introduction

SEGCapstone

This repo contains the code for the 2017 SEG4910 / SEG4911 project by Ryan Fitzgerald, Cody McCoshen, and David Ganim. It was built with React, Node, Express, and MongoDB.

Setup Instructions

In order to setup, clone or fork the repo and run npm install to install all the required dependencies in the root. You must also run npm install under the client directory. You will need to then create a variables.env file with the required credentials and keys. See variables.env.example to see necessary fields. Finally, run npm run watch from the root in order to concurrently run the Node developement server and the client React server.

If you wish to run automated tests, run npm test from the root and client footer, respectively.

For full technical documentation of the system, click here.

Test Data

If you need to populate a database with test data, first run npm run data:remove from the root to ensure no duplicates exist (NOTE: this will remove ALL data in the database), followed by npm run data:add. Since these commands clear the database of all data, it should only be run for testing purposes and not in a production environment.

Test Accounts

Here are several test accounts:

email: [email protected] password: david

email: [email protected] password: ryan

email: [email protected] password: cody

email: [email protected] password: admin

Also a set of users 1-20. For UserN where 21 > N > 0:

email: [email protected] password: user

Additional Content

This page is the landing page for everything relating to how we manage development, including development environments and our development processes.

This page is the landing page for everything relating to the architecture of our system, including the database schema and general architecture overview / breakdown.

This page is the landing page for everything to administration documents for the course and the project, including the project plan, proposal, and important links.

This page contains a number of hand-picked system design interaction examples to better understand how data flows through the system.

This page contains the user manual that briefly explains how the system works and how to get the most effective use out of it. This is meant for the customer and any employees who may be using the system.

This page is the landing page for all reports, including the quality assurance report and the impact assessment report.

This page is the landing page for all system documentation, including server-side documentation, client-side documentation, and deployment documentation.

This page includes the general project summary as well as a number of lessons learned along the way.

This page contains a list of the team members and their respective contributions to the project over the course of the two semesters.

segcapstone's People

Contributors

cmcco066 avatar ryanfitzgerald avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

segcapstone2k17

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.