ogdhruv / hirethemv2

A Django based web application for placement teachers and their students.

Hire Them 🧑‍💻

A web app to help colleges and their students.

🧪 Trying the deployed version: Register as a new user.

🚧 The application is not mobile responsive right now. 🚧

Made with :

OS used :

🌼 Features

• 👤 Custom User Model Authentication
• 📨 Integration with MailHog for local email testing
• 👥 A User Profile UI
• 💼 A Job Portal interface
• 💬 Room for Messaging or Chatting
• 🧭 A fine and easy to understand frontend
• 🗄️ Uses PostgreSQL database

📀 Installation!

💯 Recommendation : If you are using Windows kindly learn about WSL

🧭 Follow all these step from Prerequisite to Running this Project:

📖 Prerequisite

• Install 🐍 Python3 and PIP

  • alternative❓- Pyenv

• Install 🗄️ PostgreSQL

🗄️ PostgreSQL setup :

🗄️ PostgreSQL setup :

Setting up for first time user on linux :

[click here ->]

• if getting ☣️ ERROR like - Peer authentication failed for user "postgres" (SOLUTION)

if you have already have used postgres, then just create database with project name:

        $ createdb --username=postgres hirethemv2

• ✅ Important:

  • Either add this export:

      export DATABASE_URL=postgres://postgres:<password>@127.0.0.1:5432/<DB name given to createdb>
    

    in bashrc or zshrc or Enviornment variable.

  • or else add:

      export DJANGO_READ_DOT_ENV_FILE=True
    

    in bashrc or zshrc or Enviornment variable.Then you can create a .env file in root directory and add values there which is easy.

    First value to add in .env file is,

      export DATABASE_URL=postgres://postgres:<password>@127.0.0.1:5432/<DB name given to createdb>
    

👨‍🔧 Running this Project

1. Getting ready:

    $ git clone https://github.com/ogdhruv/hirethemv2.git
    $ cd hirethemv2
    $ virtualenv .venv
    $ source .venv/bin/activate
    $ pip install -r requirements/local.txt
   

2. Migrate the migrations to Postgres database:

    $ python manage.py migrate
   

3. Running the project:

    $ python manage.py runserver
   

📧 Using Email Backend

I have a user email verfication system in this project.

Right now it is set to "none" so you have to make it mendatory to use it.

1. Go to config/settings/base.py

2. On line 272, change ACCOUNT_EMAIL_VERIFICATION from "none" to "mendatory"

3. In development, you use email catching tool for receiving email because you do have any SMTP service(like mailgun). so we use an offline tool know as MailHog.

   Setting up MailHog:

   • Install latest MailHog release for your OS or Ubuntu
     
   • Run $ ~/go/bin/MailHog or else where you have go folder in the terminal.
     
   • Go to http://127.0.0.1:8025/ and check for emails when you create a user.
     

☁️ Testing Live

😶‍🌫️ Few things to keep in mind

• Images may not appear on live becuase of disk space provided by render
• Web app is not mobile friendly at this time.

📚 Refrences and Books :

• django-cookiecutter's Documentation
• LearnDjango
• SIMPLE-IS-BETTER-THAN-COMPLEX
• FullStackPython
• Django 4 By Example - Fourth Edition

🛸Deployment

• hirethemv2