mohitkh7 / easy-learning Goto Github PK

A django based social platform which provides best resources to learn anything curated by community members.

Python 50.51% HTML 35.77% CSS 9.27% JavaScript 4.45%

django social-platform hackathon-project kwoc

easy-learning's Introduction

Easy-Learning

Easy Learning will be a comprehensive web based interactive tool with a complete list of resources to learn any stuff, skills, subject based on community feedback, further tailored according to your learning ability which will also be filterable and searchable.

Setup Instruction

Create a new directory at a desired place in your file system

mkdir name_of_your_choice
cd name_of_your_choice

Create a virtual environment in recently created directory and activate it:

python3 -m venv env
source env/bin/activate

Clone the repository and enter to the repository:

git clone https://github.com/mohitkh7/Easy-Learning.git
cd Easy-Learning

Next, install the dependencies using pip:

pip install -r requirements.txt

After this create database in mysql:

mysql -u root -p<your_mysql_password>
CREATE DATABASE easylearning CHARACTER SET utf8;
GRANT ALL PRIVILEGES ON easylearning.* TO admin@localhost IDENTIFIED BY 'thepassword';
FLUSH PRIVILEGES;

Here admin and thepassword should be same as USER and PASSWORD defined in database settings in startlearning/settings.py.

Once the database table is created, Migrate your database.

python3 manage.py migrate

Then create a superuser account for Django:

python manage.py createsuperuser

Then generate a API Key:

Visit the url https://console.cloud.google.com/apis/
Sign in with your google account.
Search for YouTube Data API v3 and enable it.
After enabling go to credentials present in the left navbar.
Select a project (if none project is present then create one and select). After selecting create a API Key for it.
Save the value of API Key in the environment variable. Below command can be used for linux user.

export YOUTUBE_API_KEY =  "Your API Key"

For Windows set can be used to save the value in env variable.

Finally, you’re ready to start the development server:

python manage.py runserver

Visit localhost:8000 in your browser to see how it looks.

Contributing

You can contribute in several ways. If you know how to code or are a designer, you are welcome to contribute using pull requests.

You can also contribute by opening issues about defects and things that could be improved or request entirely new features that you think would help others.

Join the Slack Communication Channel

easy-learning's People

Contributors

Stargazers

Watchers

Forkers

adamdavis99 arpit3018 dewangmodi 091karan arnavrupde rajshah9914 jaindhairyahere gayathrivenkatesh meherc99 imskr manasa2850 chauhannishh canter-nawab rutvi1998 irinade sethips kalburgimanjunath subharanjan2019

easy-learning's Issues

Implement Mail feature in user account functionality

Mail feature should be implemented in user account. A mail should be send to registered mail id of user on following events -

Account Creation
Forgot Password Request
On Changing Password

Hide Password Guidelines

While Creating new account or changing password password guidelines appears. It should be made either hidden or more interactive.

Missing widget_tweaks placeholder in change password form file

Missing {% widget_tweaks %} in the file registration/password_change_form.html file.

Adding placeholder to add resources form

Redesign Home Page

Present home page looks quite boring and also its not user friendly. Ideas and suggestion are welcomed on how we can make it better.

brainstorm different ideas.
preparing mock sample design.
implementing it using HTML, CSS, Bootstrap.
making necessary changes in views.py file.

Update change password page using bootstrap

Currently if you view http://localhost:8000/myaccount/change_password , you will observe its not appearing good as HTML form is used. Use bootstrap form widgets and buttons along with some custom CSS to give it better appearance.

Change the learn/templates/registraion/password_change_form.html
Use Bootstrap based form

Create Favicon for the project

Create a favicon image from logo.png file available in root directory. Include it as a favicon image for the project.
How to approach:

Generate favicon image from logo.png using https://www.favicon-generator.org/ or any other online service.
Include this newly generated file as favicon by updating base.html. Ref: Adding Favicon - Stackoverflow

Migrating to Django 2

At present project is running on Django 1.11 which should be migrated to Django 2

Resource Created by user get deleted on deleting user

At present on deleting a user, all related resources created by user get deleted. It should be corrected and those resources should get associated with either anonymous user or some default user.

Error in forgot password

Error occurs when forgot password link is being clicked and login is done with that link.
NOTE: Forgot password link can be found in the console when the procedure is followed

Remove Footer

Remove footer displaying "developed by mohitkh7"` from all the pages.
How to approach -

Remove footer_wrapper div from learn/templates/base.html
Remove css code associted with it from static/css/style.css

Remove unwanted text at the top of change password form

Remove redundant print statements from view.py file

Inside learn/views.py there are mutliple redundant print statement. Some of them are commented out and some are part of code. They were written earlier during development for debugging purpose but now they are not required.
Remove all print statements from views.py file

Something reflecting learning
Combination of letter E and L
This are just suggestion from my end. You are free to use your own creativity.

Create a png file of 1:1 ratio of logo and upload it in root directory of project.

Remove pkg-resources from requirements.txt

Remove following unrequired package from requirements.txt -

pkg-resources==0.0.0

Make models.py file pep8 standard compliant

learn/models.py file is not as per pep8 guidelines. There are lots of invalid indentation and spacing. Make this file compliant to pep8 standard.

Install pycodestyle using pip install pycodestyle
run this command against models.py file, it will list down all the errors.
make necessary changes to models.py file.
add pycodestyle to requirements.txt