parthiv-2020 / udayagiri-scl-maxo

Udayagiri SCL Maxo Project

Udayagiri's Tutorvita

With the outbreak of pandemic, the educational institutions had to be shutdown which hindered the learning of a lot of students.The students have to adapt to the online methods of learning which is now the new norm. Reaching out to teachers and resource personals is a rather difficult task. With this project, any student from any corner of the world, willing to learn something can reachout to a teacher. Anyone can create an account and seek help from our verified lecturers.

---

Documentation 🔰 Report a Bug 🔰 Request a Feature

Table of Contents

1. About The Project
   • A Note for the contributors
   • Project Description
2. Getting Started
   • Installation
   • Development
3. Contributing / Adding Features

About the Project

A Note for Contributors

This is a official project repo for Udayagiri-scl-maxo which is a 40-day Hackathon. It is organised by Sushiksha, World Konkani Center. This repo is monitored. Only members from team Udayagiri are allowed to do changes and do contributions. Thus, we are not supposed to accept any PRs from anyone other then Udayagiri team members. For further details, you can get in touch with the repo owner or contributors.

Project Description

1. Backend Framework: Django
2. Front-end Framework: Bootstrap
3. Database used: Sqlite

Getting Started

Installation

Refer below video or instruction for setting up tutorvita in your device.

1. Fork and Clone

1. Fork the udayagiri-scl-maxo Repository
2. Clone the repo to your local system.

2. Create a Virtual Environment for the Project

   Install pipenv package

   pip install pipenv
   

   Run following command to create virtual env and install necessary dependecies.

   pipenv shell
   pipenv install

   If pipenv install does not work use:

   pip install -r requirements.txt
   

   Now after installing all the packages you can directly skip the development steps as we already added a sample user in database.

Development

3. Make migrations/ Create db.sqlite3

   python manage.py makemigrations
   python manage.py migrate

4. Create a super user. In Django, if you want to access admin page, you need to create an account with staff status first.

   python manage.py createsuperuser
   

   Then select your username and password. You can bypass a common password for development purposes.

5. Run the server on localhost:

   python manage.py runserver

6. Use below credetial if you want to login to admin panel/you can also create your own super user using above command

username: admin
password: admin

Contributing

Pull request are only welcommed by Udayagiri team members, if you are intereseted in the project please raise a issue regarding the same.

udayagiri-scl-maxo's Issues

Add a fevicon to the website.

Change database from Postgres to sqllite

It's difficult to set up Postgres so change the existing database to db.sqllite which is default database of django.

Create a Landing page

To create 404 error page.

Update Readme.md

Google Authentication.

Add a logo instead of text

Update Home page contents.

Update the templates with 404 error page

Create models for asking Doubts.