Giter VIP home page Giter VIP logo

world-konkani-centre / sushiksha-website Goto Github PK

View Code? Open in Web Editor NEW
35.0 6.0 33.0 28.9 MB

Official repo of Sushiksha website Repo built with Django with features of Basic CRUD operation, Ajax Calls, Profile picture Updation, Quiz section, User Analytics, Leaderboard, Slack API calls, Blog page. Feel free to Fork and contribute ;)

Home Page: https://sushiksha.konkanischolarship.com/

License: Apache License 2.0

Python 28.82% CSS 8.55% HTML 56.17% JavaScript 6.46%
django bootstrap crud-application hactoberfest2021 world-konkani-centre hacktoberfest

sushiksha-website's Introduction

Sushiksha-lOGO 

GitHub issues GitHub forks GitHub stars

Powered by Django.

Initiative by

Sushiksha Mentoring Program is organized for scholars of Vishwa Konkani Student Scholarship Fund (VKSSF) by members of VKSSF Alumni Association (VAA). Sushiksha was started in 2018 by Royal Denzil Sequeira, a member of VAA since 2015, with 20 mentees. Since then Sushiksha has grown to be family of 170 mentees and 20 mentors. Mentees of Sushiksha are undergraduate scholars of VKSSF who are determined to thrive and be successful in their area of study and career. Mentors of Sushiksha Program are experienced professionals who were once the scholars of VKSSF and have lived through their own share of successes and failures but believe in empowering the scholars early on in their career path.

Sushiksha thrives because of the dedication of its active mentees and mentors – who have contributed countless hours of work to shape their future and make it a highly productive and focused workspace.

VKSSF Alumni Association is a young and vibrant group of alumni VKSSF scholars who have successfully thrived through their undergraduate and graduate studies and are now on their path to be successful professionals.

VAA envisions a community that empowers all its people to live with dignity and fulfillment and be active contributors to society.

'Vishwa Konkani Student Scholarship Fund (VKSSF)’ envisages grant of Merit Cum Means Scholarship for students having Konkani language as their mother tongue. Instituted World Konkani Centre in the year 2010 as envisioned by the eminent thinker and corporate leader T.V.Mohandas Pai, the VKSSF has since then successfully grown into a large programme.

Table of Contents
  1. Contributing / Adding Features
  2. License

Frameworks:

  1. Backend Framework: **Django**
  2. Front-end Framework: **Bootstrap**

Installation

  1. Fork and Clone

    1. Fork sushiksha-website the Repo
    2. Clone the repo to your 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 then venv, then please mention it in .gitigonre first

  3. Install all the requirements

    pip install -r requirements.txt
  4. Checkout to develop branch

    git status
    git pull
    git branch
    git checkout develop
    
    
  5. Change the config parameters (Optional, only if you want to enable mail sending functionality)

    SECRET_KEY = 'Enter random character string'
    EMAIL_USER = 'your email username'
    EMAIL_PASS = 'Enter you email password'
    SLACK_AUTH_TOKEN: "token here"

    comment line #45 (If you are using badge giving feature other leave as it is) of users/signals.py (send_email.delay(array)) during development and uncomment before sending PR

  6. Make migrations/ Create db.sqlite3

    python manage.py makemigrations
    python manage.py migrate
  7. Create a super user. In django if you want to access admin page, you need to create an account first.

    python manage.py createsuperuser
    

    Then select your username and password.

  8. Run server

    python manage.py runserver
  9. Do the Development and send me a PR referencing the issue.

Development

git checkout develop-<username>
//Create the changes and then commit
git add <filename>
git commit -m "<Message here>"

From your master branch or your main branch that you are working on, give a PR to our develop branch.

!IMPORTANT: Don't give a PR to the master branch

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. While sending the PR please mention the issue in the Comment.

Anyone can Contribute to the site, This repo is also part of Hactober fest, so changes ranging from small css changes to extra backend app is acceptable.

Feel free to open the discussion and Issues.

License

This repository is licensed under Apache License 2.0

sushiksha-website's People

Contributors

18praneeth avatar gagan-shenoy avatar itsprathvi avatar kishorbalgi avatar krishnashenoy123 avatar nagarajpandith avatar nayakpriya avatar rajathprabhu221 avatar ramadas-kamat avatar rishabhnaik avatar shravyamallya avatar swasthikcnayak avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

sushiksha-website's Issues

House details not visible

when we select the house from the leaderboard, the details of the first house is not visible.
To recreate
->select leaderboard from navigation -> select any house -> first house details are visible
issue

Wrong mail icon in footer

Screenshot 2020-11-07 at 10 51 23 AM

Clicking on the skype icon is opening mailbox in laptop. I am assuming it's supposed to be a mail icon.

BADGE CLAIM FORM

Currently mentees use multiple claim form for Badges towards 1:1 with Mentor, Donuts, Book Reading, Blogger etc. It would be great to have a Badge Claim form within Website, which can be used by mentees to claim the badge they deserve. On the admin side, the "Decision" provision kept already to approve the badge and reward it to the mentee who claimed it.

Nit: Fix OKR Casing

Why was this issue opened?

Nit: Should be OKR and not Okr

How to reproduce?

image

Optimise website loading

The top nav bar remains fixed through out:
image

So, every time a search or page navigation happens, you don't have to load the navbar again. You can keep the navbar fixed and provide the circular progress loader only for the below section of the web page. This way, you can optimise and reduce loading time.

Essential - Team Level Badges

It is important to have Team Level Badges so as to award certain points to Teams on winning team competitions. Team Level Badges can display below the Individual Team Leaderboard.

Error in Homepage

Update the tagline to "An interactive platform for students with a Growth Mindset."

Members display page

  • In Members page, you can have 2 tabs named - Mentees and Mentors and display profiles accordingly based on role.
    The main idea is to have easier segregation/filtering of profiles.
  • Display profiles in the alphabetically sorted manner in each tab.

Fix Edit Profile

Why was this issue opened?

The Edit Profile button is not clear on first sight

How to reproduce?

image

Improving pagination

Description.
In the pagination, the user could only see the current page number and can go to 1 next and back, It would be better if it is possible to switch between more than 1. Let's say I'm on page 4 and I want to go to page 1, I have to press back button 4 times.

Possible solution
Adding a first and last page numbers, and skip by more than one pages.

Grammar corrections on the main page

  • 170 Mentee should be 170 Mentees

  • 20 Mentor should be 20 Mentors

  • 'An a interactive platform....' should simply be 'An interactive platform.....'. Also, G & M should not be capitals in the 'Growth Mindset' at the end of the sentence.

A separate tab for Badges in Header or Footer

Currently, to give a badge we have to visit a member profile. There should be a separate menu option on all the pages, preferably under a drop down(profile?) from which any user can select any username and give any badge.

This requires some work but it has to be done sooner or later.

Website Optimization

Hello everyone 🖖

I was checking GitHub for labels under good first issue but I also want to help sharing some website optimizations tips.

Image Resize

This image: https://sushiksha.konkanischolarship.com/media/blog-post-thumbnail/SCL_Wall_Paper_Wide.jpg has a whooping 3.3 MB size. It's enormous. Even with a 4K monitor, it's big. I used Cloudinary with JPEG Mini to compress and resize the photo and it's down to 228 KB 😄

SCL_Wall_Paper_Wide_yj3jn7

I also resized this one: https://sushiksha.konkanischolarship.com/media/blog-post-thumbnail/Sushiksha_Logo.jpg, from 817 KB to 218 KB.

Sushiksha_Logo_tmzakq

A LOT of icon font

So you are using three icon fonts:

…icofont/icofont.min.css(sushiksha.konkanischolarship.com) | 25.3 KiB | 270 ms
…css/boxicons.min.css(sushiksha.konkanischolarship.com) | 22.3 KiB | 270 ms
…remixicon/remixicon.css(sushiksha.konkanischolarship.com) | 14.6 KiB | 230 ms

My suggestion is to stick with one.

Font Optimization

I suggest you put your font loading on "swap". You can check out more about this property on MDN.

Lighthouse Report

I generated a PDF with Lighthouse recommendations. 😄

lighthouse-big-report.pdf

Give a badge page - content updates

Top "Give a badge to XX" section:

  1. "Describe why you are giving the badge": Change "your" to "you".
  2. Badge dropdown: Don't say Badge for each entry. The title of the dropdown says it's a badge and hence is redundant if you say badge for every entry. I think the dropdown should also say how many points each badge cost. And finally, I would not capslock the badge names.
    Tl;dr : I propose "Angel (1 pt)" for what the current "Badge: ANGEL" should look like

Badge listing (the one with icons)
3. Usually when you say * (for Angel and Rockstar) the immediate response is to see at the bottom of the page (in this case bottom of listing) to see what the * means. I understand it is described in the Red pod on the left, but I think we should have a small "* Mentors only" in the bottom of the listing.
4. Lets be consistent about using fullstops or not after the badge description. I think we shouldn't have fullstops since its more of a caption and not full sentence.
5. "BRAIN WAVE: To that buddy who brainstormed my problem with me": Re-writing it a bit.
6. "EXTRA MILE: To the person who went out of their way to help me": Change "the" to "their".
7. Perhaps change the caption of Gracias to be consistent with other captions: "To the person whom I owe a lot" (its okay to have same caption for both Gracias and Gracias by mentors.
8. "PICTURE PERFECT: To the person who has a beautiful profile picture": again to be consistent.
9. ROCKSTAR *: ROCKSTAR OF SUSHIKSHA: I think making this as exception is fine. However remove "the" before "Sushiksha"
10: "SWISS KNIFE: To that multi-tasker who has solutions for everything": "Multi Tasker" changed to "multi-tasker", "got" to "has", "solution" to "solutions"

Red pod on the left:
11. "Why give a badge?": De-capitalize both Give and Badge
12. "Rules for giving a badge": Instead of "badges" say "a badge"
13. "You cannot give a badge to yourself': Change "for" to "to"
14. "Give a badge only when you feel the person deserves it.": Change "badges" to "a badge".
15. "A badge with '*' can be given only by the mentors. (rewrote the sentence a bit).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.