Skip to content

Latest commit

 

History

History
162 lines (105 loc) · 10.3 KB

README.md

File metadata and controls

162 lines (105 loc) · 10.3 KB
Raw

Maintainability Test Coverage

Video Journal For Teams | Alpaca Videos!

Project deployed here: [https://www.alpacavids.com]

Staging site deployed here: [https://staging.alpacavids.com]

Contributors

Kerri-Ann Bates Michael Nunes Sofia Levin Darrin Lowery Sam Allen

Netlify Status React code style: prettier MIT

Project Overview

Tagline: It's how you asynchronously record and store practice videos for interviews then get feedback from team members.

Trello Board

Product Canvas

UX Figma Design

UX InVision Prototype

Key Features

  • Login/Register with Passport
  • User Dashboard: shows the teams you joined and your videos
  • Team Dashboard: shows the team members, interview prompt questions, and team videos
  • Video Viewer: plays a video and allows members to provide feedback / view feedback
  • Update User Profile capability
    • User can update their account info
  • Team Manager can manage teams
    • Modify regular team member role to manager role / vice versa
    • Invite / Remove members from team
  • Create new video prompts
  • Video Recording
    • Videos can be recorded in-app and uploaded (posted) to a team
  • Video Storage / Streaming

Tech Stack

Front End built using: React

Front End libraries and dependencies can be found in package.json, but major highlights are:

  • Redux
  • Redux-Persist
  • Axios
  • Ant Design / node-sass for the UI

Testing is handled by jest / react-testing-library / enzyme / redux-mock-store

Back End built using: Node

Back End production pipeline deployed at Heroku-Production

Back End staging pipeline deployed at Heroku-Staging

List of major Back End dependencies:

  • Express
  • Knex
  • Postgres
  • Helmet
  • Cors
  • Passport
  • bcrypt
  • jsonwebtoken

Testing is done with jest / supertest Development server is run with nodemon

APIs

Our API does not rely on third parties nor requires any external services

Environment Variables

In order for the app to function correctly, the user must set up their own environment variables. There should be a .env file containing the following:

Testing

Jest testing environment along with Enzyme dev dependency for testing React-Redux

Installation Instructions

Packages can be installed locally with either: yarn install or npm install.

Scripts

  • npm run build used on Netlify deployment

Can be ran with either yarn or npm.

  • start: to render a local development browser,
  • test to run local tests
  • coverage to generate test coverage report with jest

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct. Please follow it in all your interactions with the project.

Issue/Bug Request

If you are having an issue with the existing project code, please submit a bug report under the following guidelines:

  • Check first to see if your issue has already been reported.
  • Check to see if the issue has recently been fixed by attempting to reproduce the issue using the latest master branch in the repository.
  • Create a live example of the problem.
  • Submit a detailed bug report including your environment & browser, steps to reproduce the issue, actual and expected outcomes, where you believe the issue is originating from, and any potential solutions you have considered.

Feature Requests

We would love to hear from you about new features which would improve this app and further the aims of our project. Please provide as much detail and information as possible to show us why you think your new feature should be implemented.

Pull Requests

If you have developed a patch, bug fix, or new feature that would improve this app, please submit a pull request. It is best to communicate your ideas with the developers first before investing a great deal of time into a pull request to ensure that it will mesh smoothly with the project.

Remember that this project is licensed under the MIT license, and by submitting a pull request, you agree that your work will be, too.

Pull Request Guidelines

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, including new plist variables, exposed ports, useful file locations and container parameters.
  • Ensure that your code conforms to our existing code conventions and test coverage.
  • Include the relevant issue number, if applicable.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Attribution

These contribution guidelines have been adapted from this good-Contributing.md-template.

Documentation

See Backend Documentation for details on the backend of our project.