README.md

 

A project by team Ayusheer as part of SCL-Maxo organized by World Konkani Centre

Ne-Meet

Classes made easy!
Documentation

View a Live Demo · Report a Bug · Request a Feature

Table of Contents

1. About The Project
   • Project Description
2. Getting Started
   • Installation
3. Contribution

Project Description

Ne-Meet

A video conference app oriented towards better digital education. The app provides seamless video streaming with quality notes running at the same time. This is completely inclined towards the betterment of the students.

Technologies Used:

1) Python      
2) HTML        
3) CSS         
4) Java Script 
5) Flask       
6) Twilio      
7) Socket-io   
8) MySQL       

Installation

1. Fork and Clone

   1. Fork the Repo
   2. Clone the repo to you computer.

2. Create a Virtual Environment for the Project

   In Windows

   python -m venv venv
   
   venv\Scripts\activate

   In Ubuntu/MacOS

   python -m virtualenv venv
   
   source venv/bin/activate

   If you are giving a different name to venv, then please mention it in .gitigonre as well

3. Install all the requirements

   pip install -r requirements.txt

4. Create a folder that stores the uploaded PDFs.

5. Create a file called .env and copy the contents from envtemplate to it. Change the config parameters

   # api keys
   TWILIO_ACCOUNT_SID='your twilio account sid'
   TWILIO_API_KEY_SID='your twilio api key sid'
   TWILIO_API_KEY_SECRET='your twilio api secret'
   TWILIO_AUTH_TOKEN ='your twilio api auth token'
   
   #database credentials
   SECRET_KEY='your secret key'
   DATABASE_INFO='mysql://usernmame:password@server/database'
   
   PDF_UPLOAD='absolute path to the folder where the pdfs are to be saved'
   
   # mail credentials
   MAIL_ID='your mail id'
   MAIL_PASSWORD='your mail password'

6. Execute python app.py to start the server

Contribution

All sorts of contribution are welcome. It would be our pleasure if you can contribute to us in some way.

1. Fork the Project
2. Create your own branch(git checkout -b 'mybranch')
3. Open a Pull Request