Skip to content

Latest commit

 

History

History
124 lines (79 loc) · 8.02 KB

README.md

File metadata and controls

124 lines (79 loc) · 8.02 KB

Degpeg in 100 Days of Feature Request

We are so excited to have Degpeg in the first edition of 100 Days of Feature Request. This is the offcial repository of brand Degpeg for 100 Days of Feature Request, where you will be able to submit your Pull Request regarding any new feature as a contribution for the contest.

About the Brand

Degpeg is a Cloud-based Live commerce platform, to enable multi-streaming with eCommerce capabilities, to market & sell Digital or non-digital products via the web, mobile & Social communities ( FB, Youtube, Instagram, Linkedin, Twitter, Twitch, etc. ).

We enable brands to start selling through Live-streaming on their website and mobile application with 30+ connected social media handles/marketplaces all at the same time. With Degpeg monetize your social communities and increase your reach and sales.

Problem Statements

Statement No. 1

User analytics and insights for live streaming

  • Inputs : You have to observe the key parameters that needs to be collected from users watching a live stream without friction. Also, you have to take care of the insights that wil be driven from the parameters to help the different D2C or consumer brands. Take a note of the actions that the brand can take on the insights to target their potential customers for better engagement and conversion.
  • Expected Output
    • Build a feature requirement document covering all aspects of data collection, insights and visualization, including wireframes and designings.
    • You also have to provide the Javascript SDK to collect identified metrics, Visualization of metrics in Angular 2+ using libraries like chart.js.

Statement No. 2

Stream to TikTok from degpeg platform and monetize it

  • Inputs : You have to build the technology to stream to TikTok from degpeg platform and build a call to action to monetize the live stream.
  • Expected Outputs
    • You have to deliver the working demo and code of streaming tiktok as well as step-by-step documentation of configurations required.

Statement No. 3

Live commerce SDK

  • Inputs : The aim is to complete the transaction (buy, subscribe, download, etc) while watching the video without friction.
  • Expected Output
    • You have to build a feature requirement document covering all aspects of the SDK along with wireframes, UI/UX designs and user flows.
    • Moreover, provide the Javascript and HTML SDK built on top of video.js with functions to add to cart, download, subscribe, collect information, etc with good design and user experience.

Note - Submissions should be complete and of production quality with good UI and UX. Only the ones that meet the criteria will be eligible.

You can find the same problem statement as issues. Read the issues and mention them while submitting a Pull Request.

Rewards

Degpeg will award the contributors with the following perks:

  • The best contribution of problem statement number 1 will get a cash prize of 5k INR for each desired output.
  • The best contribution of problem statement number 2 will get a cash prize of 10k INR.
  • The best contribution of problem statement number 3 will get a cash prize of 5k INR for each desired output.
  • All contributors will be eligible for Amazon Gift Cards worth upto 1k INR.

Table of Contest

Contributing

Getting Started

To get started with the contribution in the Degpeg repository, simply fork it into your local GitHub account. Make the changes in the forked repository. In this case, the change will be related to the feature that you will be putting in. You can also clone the repository first, and then fork and push it along with the changes. This will also raise a PR.

Note: Please be aware that Degpeg will not share any codebase for this challenge. You are free to develop your own solution using your creativity and imagination (Like that in a hackathon). But, you have to keep the problem statament in mind while developing a solution.

Submission Guide

To make a submission for the brand Degpeg in 100 Days of Feature Request, as a first step, fork the repository by clicking the fork button at the right hand corner. In the forked repository, you will be able to make changes and upload your code regarding the feature that you will be making and contributing.

In the forked repository, create a folder and in that folder, add all the required codes and documents needed for the feature. The folder name should contain your name and the name of the feature which you have built. After naming the folder and later on adding and uploading the contents inside the folder, you will be ready to raise a pull request.

In the folder, you must have to make a README.md file which will have a detailed description about the feature solution.

When you are raising a Pull Request, keep in mind to give a proper title of the PR which will be relevant to the changes. In the description section, give a proper description that will tell the summary of the feature request that you have built. Also, you can use markdown in the description that will help you to embed any link or add anything relevant with the description.

Creating Pull Requests

  1. When you're ready to submit your changes, add a descriptive title and comments to summarize the changes made.
  2. Select Create a new branch for this commit and start a pull request.
  3. Check the Propose file change button.
  4. Scroll down to compare changes with the original document.
  5. Select Create pull request.

Commenting on Pull Requests

Once a pull request is submitted, multiple committers may comment on it and provide edits or suggestions which you can commit directly. You can also add line comments. Take a look at Commenting on pull requests for more details.

Labelling Pull Requests

A raised Pull Request will be labelled according to the work that has been done in the Pull Request. There are several labels to determine the work that is on-going with the Pull Request. For example, we requested a change in the pull request from the submitter, then the PR will be labelled as awaiting submitter action.

Reviewing Pull Requests

The Pull Requests will be reviewed on a first come first serve basis. The community and product team of SAWO Labs will be responsible for the reviewing of Pull Requests. Keep in mind that spams will not be tolerated.

While reviewing the Pull Requests, we may contact the submitter of the PR regarding any changes that need to be made. If the submitter doesn't respond even after making several calls, then we will be forced to close the PR by labelling it as incomplete.

Once the review process is complete, the change is either merged into master and pushed immediately or merged into the release branch and pushed in alignment with the release. The branch is then deleted.

Building and Validating

If you've downloaded the repository and are making a feature on your local machine, you can generate the HTML files from markdown. You can review your changes before you commit them or create pull requests.

Note: Commands can be executed on Linux, Mac, and Windows (using Powershell).

  1. Open a terminal window, then clone a forked copy of the Degpeg repository by running the following command::
https://github.com/Sawo-Community/Degpeg.git
  1. Install pipenv by using one of the following commands based on your operating system:

For Mac users where Homebrew is installed:

brew install pipenv  

For other operating systems

pip install pipenv