naveens143 / rportal1

Rp draft 1

                   

Research Portal Backend

Table of Contents

1. Walkthrough of the Research Portal
   • Problems faced by research aspirants
   • Solution
   • Hierarchy
   • Benefits
   • Built With
2. Getting Started
   • Installation
   • Setup Guidelines
3. How to Contribute
4. Contacts
5. Contributors

Walkthrough of the Research portal

We often see that students tend to give up easily on research work and students with high aspirations shift to other fields of industry experience.

Problems faced by research aspirants :

• The process of getting a research project can be very tedious and most students find it difficult.
• People interested in core have to wait until 2nd or 3rd year to know interesting topics in their domain
• Most of the 1st and 2nd year students don’t even know about the exact process of applying for research projects

Solution :

By providing the students with a laid-out path to overcome this intensive and difficult process the solution is to make a Research Portal.
With this Research Portal, students won’t need to search for projects anymore and can easily find and apply to projects of their interest. In the Research portal a faculty can post for projects they are currently working on and might need assistance . These projects will then appear in the students feed. Interested students can then apply for them and the faculty can select them depending on their skill levels

Hierarchy :

There are 2 user groups: student and teacher

Signup/login:

Signup and update your account with necessary details like name, department, work email, phone number, etc. An email verification will be sent to the email id provided. Institute email id is necessary for verification as groups are auto-assigned based on that.

Projects feed:

Active projects by teachers will be shown here.Upload your grades and necessary documents for the project you like and wait to be shortlisted.

Benefits :

• Finding Research Projects made easier and much faster.
• Research projects posted throughout the year.
• Enhancing the CV of students by participating in research projects.

Built With:

Django
Django Rest Framework

Getting Started

Installation:

For Windows

Add the following to requirements.txt (only for windows)

pip install python-magic-bin

For Linux/Debian

sudo apt-get install libmagic1

Install virtualenvironment (if not already)

pip install virtualenv
virtualenv myenv

Activate virtualenv

myenv\scripts\activate

PS : Linux Users follow different guidelines For further details refer https://www.geeksforgeeks.org/creating-python-virtual-environment-windows-linux/

Django Installation ( Developer Mode )

pip install -r requirements.txt
python local.py makemigrations
python local.py migrate
python local.py runserver

Setup Guidelines:

• After sucessfull installation create a .env in the directory where settings.py is located
• It must have the content as follows :

SECRET_KEY=
DEBUG=True
EMAIL_HOST_USER=
PASSWORD=

Navigate to localhost:8000 to see the magic
PS 2: For more details refer to this tutorial Tutorial

Contribution Guidelines

Before making a migration run

python local.py makemigrations --dry-run --verbosity 3

to make sure if it breaks any thing

• Fork this Repo
• Create a branch in the forked repo

git checkout -b develop

• Make Changes
• Push to your repo & make a pull request

PS 3 : Instructions to update git forked repo Medium

Contacts

Website :     https://www.ieeesbnitdgp.com/
Github :       https://github.com/ieeesb-nitdgp

Contributors

Sayan Mondal

Bishwajit Ghosh

Durbar Chakrabarty

Sreemoyee Sadhukhan

Naveen Leo

For any suggestions, create an issue or start a discussion in the discussion tab.