Skip to content

Commit

Permalink
Updating README for open source release
Browse files Browse the repository at this point in the history
  • Loading branch information
pritamps authored Nov 13, 2020
1 parent 2448788 commit cfc31b3
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,34 @@
# ivideo_frontend
# Plio Frontend

## TODO for feature parity
Plio is an open-source AI-based platform that enables personalized learning through free interactive
videos.

[ ] Phone number recording
[ ] Django pe - we need APIs for
This repo contains code for the frontend, in Vue.

## PR Strategy
It includes features for:

0. **Master should be stable at ALL times**
1. Small commits -> Push directly to master, no need of PR (purposely allowing this to build trust and confidence!)
2. New features -> Make feature branch, PR with master, merge with master.
3. One more features ready for relase -> Merge with release, will be auto-deployed and show up quite soon
4. Super urgent stuff -> No need for PR. Push to master
1. A player that overlays items (currently assumed to be questions) on top of any video (currently assumed to be from YouTube(
2. Recording the phone number of the user (currently without any authentication).

Avanti mein master and release are protected and all. But I think, trust ke saat kaam karna zyaada important hai. So we should have the power to push directly, we just shouldn't use it unless absolutely necessary.
## Priorities

Yeh clear hai?
We are keeping the features *extremely* simple, because our target market is students from low-income backgrounds in India.
Some of them don't have their own phones and borrow from their families, and some of them have only KaiOS feature phones.

Hence, we have decided that the platform will:

1. Recommend high-quality free video content in local languages,
2. Automatically build interactive lessons on top of these videos,
3. Work on feature phones,
4. Be freely available.

some


## Issues

Please feel free to open a PR if you know how to solve any of these!

* Our code doesn't work on some low-end mobile browsers.
* We don't have much knowledge on cross-browser testing
* Our Vue architecture may not be state-of-the-art.

0 comments on commit cfc31b3

Please sign in to comment.