If opportunity doesn't knock, build a door.

Lyhnidas Your Job Coach

Live Site:

Lyhnidas Your Job Coach

Repository:

Lyhnidas Your Job Coach Repository

Developer:

Xhensila Stambolliu

About

This is a full-stack project built using Django, Python, HTML, CSS, and JavaScript. I have created this website for my fourth project of the codeinstitute's Diploma in FullStack Development. It is a website which helps job seekers and recruiters come together and hire easily built using Django Framework.

Table of Contents

1. Project Aim
2. [User Experience]()
   1. Target Audience
   2. [Apps]()
   3. Design
   4. Scope
   5. User stories
3. [Technical]()
   1. Agile
4. Features
5. Marketing
6. Bugs
7. Technologies Used
8. Testing
9. Deployment
10. Credits
11. Acknowledgments

Aim

To create a web application which will allow helps job seekers and recruiters come together and hire easily. A user can easily access the website to search and apply for a job, and also, a user can add a job as a recruiter.

Database Design

Database Schema

User Account

This app is use for all authentication, profile and account purposes. I am using the allauth package to handle the authentication. Also, I am only using account login providers, so we are free from any password handling and recovery issues.

---

Login

SignUp

base.html This is the base of the entire website which each other webpage extends from. It contains the header and footer of the website. It links this template to all the CSS and JS files. I have used Bootstrap4 CSS and JS files and a pair of other CSS files. Thereare two sections for the navigation bar, one for the recruiter side and the other for the candidate side. Also,there is a button to move to the other side.

---

The default opening is on the candidate side.

---

The default opening is on the recruiter side.

---

It also has the login button when the user is not signed in, and when loged in, the login button disappears, and the logout button appears.

---

Recruiter Nav after Login

---

The footer is the same. There are some links to pages and some details about the website and some social media handles. All the social media links open on a new page and redirect to Lyhnidas Pages.

---

Sign Out

Candidates App

In the candidates part, are all the things relevant to the job seekers (candidates), which consists of the job search, job application and saving of jobs. It also shows the current status of the application, whether its accepted, pending or rejected. Also, there is an intelligence search feature built-in which shows the jobs which are the best fit for the user based on the skills skills and job requirements.

Firstly is defined a CHOICES variable which consists of four choices (Full Time, Part Time, Internship, Remte), which is used in the Profile class.

Profile— This class contains all the information about the candidate. It is linked to the default User model of Django. It also consists of the full name, country, location, resume, graduation year and looking for an option. It also has a slug option, which helps to generate a slug from the user variable. Resumes are stored in cloud storage. It also has a function which returns its absolute URL with the help of a slug. Skill- This is the model class which contains the skill and a foreign key linking to the User.

SavedJobs - This is the class of the model which consists of three parameters — job, user and date_posted. Job links it to the Job model from the recruiters' App, user links with the User Model, and date uses the current time via the Django timezone. The purpose is to store the jobs saved by a user.

AppliedJobs - This is the class of the model which consists of three parameters — job, user and date_posted. Job links it to the Job model from the recruiters' App, user links with the User Model, and date uses the current time via the Django timezone. The purpose is to store the jobs applied by a user. It is very similar to the Saved Jobs class.

forms.py The forms part consists of two forms which is used for the candidates part of the website: ProfileUpdateForm and NewSkillForm.

1. ProfileUpdateForm — The purpose of this form is to enable a user to update his candidate profile. The user can update all the parameters of the Profile model class.

2. NewSkillForm — This form is used to add a new skill to the skills model class for a user.

Recruiters App

In the recruiters part, there are mostly all the things which are relevant to the recruiters and hiring companies, which consist of the job posting, getting candidates applying on job posts, selecting these candidates and also viewing the resumes of all the candidates on the database. It also shows the current status of the job post, like how many have applied and can see the applicants list. Then can select or reject them based on their profile and resume. Also, there is an intelligence search feature built-in which shows the candidates who are the best fit based on their skills and job requirements to save time.

Firstly is defined a CHOICES variable which consists of four choices (Full Time, Part Time, Internship, Remte), which is used in the Job class.

Job - This class contains all the information relevant to the job post. It has a recruiter variable which links it to the Recruiter posting the job post. It also has all details about the job, like the title, location, company, description, skills required and the type of the job, whether it is a full-time job, part-time job, an internship or a remote opportunity. There is also a link section which can be left blank (only required when the recruiter wants to accept applicants on their website). It also has a slug that helps create unique slugs based on the job title.

Applicants - This class stores all the data related to the candidates who have applied to a particular job post. It has a job variable linking it to the relevant job, an applicant variable which links it to the candidate who applied and a date when the candidate applied.

Selected - This is the class which stores all the data related to the candidates who have been selected for a particular job post. It has a job variable linking it to the relevant job, an applicant variable which links it to the candidate who was selected and a date when the candidate was selected.

forms.py

The form consists of two forms which is used for the recruiters part of the website: NewJobForm and JobUpdateForm.

1. NewJobForm — The purpose of this form is to enable a recruiter to post a new job.

2. JobUpdateForm— Recruiters use this form to update an existing job post.

Scope

• A simple, straightforward, intuitive UX experience;
• Explicit content;
• An easy navigation for the user through all the pages and features;
• A site that is visually appealing on all screen sizes.

Structure

• A clear and straightforward layout is in place to ensure users can navigate intuitively and have an enjoyable browsing experience.
• Mobile navigation is the same on all pages to ensure easy navigation.
• Footer is fixed on the bottom with links to social media.

User Experience

User Stories

*Epic: Viewing & Navigation of the web app as a Job Seeker works as expected

1. As a ... first time user... I can... see the home page of the website and jobs so that I can ...decide whether or not I should sign-up...
2. As a ...first time user... I can ...easily navigate to the log in so that I can ...create a profile...
3. As a ...first time user, as a candidate... I want to be able to... know what is expected of me on the home page so that I can ...easily navigate and find information...

• EPIC: Registration & User accounts work as expected

  4. As a ...Candidate.. I can be able to ...easily login and log out... so that I can ...ensure my account is secure...
  5. As a ...candidate... I can be able to ...have a personalised user profile... so that I can ...view and update my details...
  6. As a ...Recruiter... I can be able to ...easily login and log out... so that I can ...ensure my account is secure...

• Epic: Job Sorting & Searching work as expected

  7. As a ...candidate... I can be able to ...search for a job by title or locaton... so that I can ...find a specific job I'm interested in...
  8. As a ...candidate... I can ...see and access all job listed... so that I can ...apply on different job positions....

• Epic: Applying & Saving Jobs work as expected

  9. As a ...candidate... I can ...read/ apply/ save a job... so that I can ...ensure maximum engagement in my profile...
  10. As a ...candidate... I can be able to ...read/ apply/ save a job... so that I can ...alter how I would like my job application to look to allow for maximum engagement...

*Epic: Viewing & Navigation of the web app as a Recruiter works as expected

11. As a ...first time user... I can ...see the home page of the website and jobs... so that ...I can decide whether or not I should sign-up...
12. As a ...first time user as a recruiter... I want to be able to ...know what is expected of me on the home page... so that I can ...easily navigate and find information...
13. As a ...first time user... I can ...easily navigate to the log in... so that I can ...create a profile...

• Epic: Job Posting & Selecting Candidates works as expected

  14. As a ...Recruiter...I can ...Read/ edit/ delete a job post & Candidates... so that I can ...ensure the perfect candidate for the job position...
  15. As a ...Recruiter... I can be able ...to Read/ edit/ delete a job post & Candidates... so that I can ...ensure the perfect candidate for the job position...

• EPIC: Site management

  16. As an ...admin... I can ...add/edit/update/delete a job post... so that ...maintain the site and remove any inappropriate contents...
  17. As an ...admin... I can ...review all job posts... so that I can ...maintain the site and remove any inappropriate post...

Agile methodology

• All functionality and development of this project will be managed through GitHub issues, milestones and projects.

All sprints are described here.

• Sprint 1 19/03/23 - 20/03/23 (Finished at 21/03/23)

  • Initial setup
  • Install django
  • Install Allauth
  • Add Allauth templates to project templates
  • Create base.html
  • Create LyhnidasYourJobCoach project
  • Create style.css and footer.css
  • Create responsive navigation

• Sprint 21/03/23 - 23/03/23 (Finished on 23/03/23)

  • Add Recruiter app

  • Set up all Recruiters view

  • Set up recruiter details (rec_details) view

  • Set up add_job view

  • Set up edit_job

  • Set up job_detail

  • Set up all_jobs

  • Set up search_candidates

  • Set up job_candidate_search

  • Set up applicant_list

  • Set up selected_list

  • Set up select_applicant

  • Set up remove_applicant

  • Add Candidates app

  • Set up home view

  • Set up job_search_list

  • Set up job_detail

  • Set up saved_jobs

  • Set up applied_jobs

  • Set up my_profile

  • Set up edit_profile

  • Set up profile_view

  • Set up delete_skill

  • Set up save_job

  • Set up apply_job

  • Set up remove_job

  • Add Urls for Recruiters App and Candidates App

• Sprint 3 23/03/23 - 26/03/23 (Finished on 26/03/23)

  • Customise allauth templates
  • Set up templates
  • Set up neccessary views

• Sprint 4 26/03/23- 28/03/23 (finished 28/03 2023)

  • Customise login templates
  • Customise templates
  • Add messages

• Sprint 5 revising the project and making neccesary fixes 29/03/23 - 31/03/23 (Finished on 31/03/23)

  • Debug and fixes
  • Remove heroku app and reset databases to run locally
  • Add new model and databases
  • Fix views to add login required, search and category sorting functionality
  • Testing
  • Document all testing, revise code and complete README.md

Features

• Responsive design.

• Website title and information on the site's purpose.

• Navigation Menu (Site Wide).

• Postgress databases to store information and user login/profile information.

• Cloudinary to store static files

• CRUD Functionality

• Login functionality.

• Logout functionality.

• Ability to view all job posts.

• Ability to view job details.

• Ability to be able to search for job

• Ability to search job by title and location,

• Ability to apply, save and remove job.

• Ability to Update profile.

• Ability to see applied, Saved jobs

• Ability to see if a user is selected, rejected or in process for a job

• Ability to add and edit of job posts.

• Ability to manage applicants list and selected list

• Ability to search for candidates.

• Admin creation and management of job posts.

Importance and Difficulty

Feature	Difficulty	Importance
Postgress databases to	5	5
store information and
user login/profile
information
:--------------------	---------------	---------------
CRUD Functionality	5	5
:--------------------	---------------	---------------
Admin creation and	5	5
management of Posts
:--------------------	---------------	---------------
Ability to view all	2	5
job posts.
:--------------------	---------------	---------------
Ability to view	2	5
job details
:--------------------	---------------	---------------
Ability to search	2	5
for a job by title
and location
:--------------------	---------------	---------------
Ability to apply,save	3	5
and remove job
:--------------------	---------------	---------------
Ability to Update	3	5
Profile
:--------------------	---------------	---------------
Ability to see Applied,	3	5
Saved Jobs
:--------------------	---------------	---------------
Ability to see selected	3	5
rejected, in process
candidates
:--------------------	---------------	---------------
Ability to Add and	5	5
edit a job
:--------------------	---------------	---------------
Ability to manage	5	5
jobs and candidates
:--------------------	---------------	---------------
Registered user can	5	5
add a job
:--------------------	---------------	---------------
Login functionality	3	5
:--------------------	---------------	---------------
Navigation Menu	3	5
(Site Wide)
:--------------------	---------------	---------------
Responsive design	2	5
:--------------------	---------------	---------------
Website title and	1	5
information on the
the site purpose
:--------------------	---------------	---------------
Logout functionality	1	5
:--------------------	---------------	---------------
Search functionality	3	3
:--------------------	---------------	---------------

Future Features

This project will be maintained in the future for the purpose of a job portal. Some features that I would like to implement are listed below.

• Allow for the use of social sign ins.
• Better form validation.
• Add a limit for job postings by recruiters
• For more job posts implement a payment
• Add create/ generate CV section for candidations
• Implement better filters
• User permissions / groups to allow staff to have non-breaking access to the CMS.
• Further improve user experience.
• Add a FAQs, subscribers list, and contact section.

Marketing

• This site has a link to Lyhnidas Social Pages (Facebook, twitter, LinkedIn and gmail adresse) with a link on the page footer.

• Colours

The Colour scheme was generated using the eyedropper plugin to get one colour from the logo image and colours to create the colour palette. A simple pallette using blue and white and complimented by bootstrap colors and classes was eventually decided on.

• Font Selection

Two complimentary fonts were chosen with Google Fonts to be used across the website.

The chosen fonts were Lato for the site.

Technologies Used

• HTML
  • This project uses HTML as the main language used to complete the structure of the Website.
• CSS
  • This project uses custom written CSS to style the Website.
• JavaScript
  • JavaScript is used on multiple pages to manipulate the DOM.
• Python
  • This projects core was created using Python, the back-end logic and the means to run/view the Website.
  • Python Modules used (These can be found in the requirements.txt project file):
• Django
  • This project was created using the Django framework, the back-end logic and the means to run/view the Website.
• Bootstrap
  • The Bootstrap framework 4 was used through the website for layout and responsiveness.
• Google Fonts
  • Google fonts are used in the project to import the fonts for the site.
• GitHub
  • GithHub is the hosting site used to store the source code for the Website, as well as github projects to manage the planning and implementation of all functionality using a kanban board.
• Gitpod
  • Gitpod is used as version control software to commit and push code to the GitHub repository where the source code is stored.
• Heroku
  • Heroku was used to deploy the live website.
• Google Chrome Developer Tools
  • Google chromes built in developer tools are used to inspect page elements and help debug issues with the site layout and test different CSS styles.
• Font Awesome
  • All the Icons displayed throughout the website are Font Awesome icons.
• Favicon
  • Favicon.io was used to make the site favicon
• Cloudinary
  • Cloudinary is an end-to-end image and video-management solution for websites and mobile apps, covering everything from image and video uploads, storage, manipulations, optimizations to delivery.
• humanize
  • Provides an easy human readable time format when viewing posts.
• crispyforms
  • To render django forms in an elegant manner and one which interacts very well with bootstrap styling.
• AutoSlug
  • To generate slug
• django-countries
  • A Django application that provides country choices for use with forms, flag icons static files, and a country field for models.
• django_filters
  • Django-filter is a reusable Django application allowing users to declaratively add dynamic QuerySet filtering from URL parameters.
• cities_light
  • This add-on provides models and commands to import country, subregion, region/state, and city data in your database. (Removed from project/ Not used)
• django_summernote
  • Allows to embed Summernote into Django very handy. Support admin mixins and widgets.

Testing

Testing is required on all features and user stories. All clickable links must redirect to the correct pages. All forms linked to the database must be tested to ensure they insert all given fields into the correct collections.

HTML Code must pass through the W3C HTML Validator. CSS Code must pass through the W3C CSS Validator.

JavaScript code must pass through the JSHint Validator.

Python Code must pass through PEP8 Validator

The website was extensively tested as it was developed using:

• print().
• The terminal by printing the expected outcome.
• Testing User Stories.
• Testing scenarios manually.
• Testing functionallity manually.

This project has been tested throughout its inception. Each input has been thoroughly tested to make sure that any invalid inputs are handled correctly and a response is shown to the user.

Full test results can be found here

Deployment on Heroku

This project was deployed through Heroku using the following steps:

Requirements and Procfile

Heroku needs to know which technologies are being used and any requirements, so I created files to let it know. Before creating the Heroku app, create these files using the following steps in GitPod:

• In the GitPod terminal, type pip3 freeze --local > requirements.txt to create your requirements file.
• Create your Procfile and insert the following code: web: gunicorn jobcoach.wsgi and make sure there is no additional blank line after it.
• Push these files to your repository.

Creating Heroku App

• Log into Heroku
• Select 'Create New App' from your dashboard
• Choose an app name (if there has been an app made with that name, you will be informed and will need to choose an alternative)
• Select the appropriate region based on your location
• Click 'Create App'

Connecting to GitHub

• From the dashboard, click the 'Deploy' tab towards the top of the screen
• From here, locate 'Deployment Method' and choose 'GitHub'
• From the search bar newly appeared, locate your repository by name
• When you have located the correct repository, click 'Connect'

Environment Variables

• Click the 'Settings' tab towards the top of the page
• Locate the 'Config Vars' and click 'Reveal Config Vars'
• Enter all variables needed.
• Deploy the website

Deploy

• In Heroku, once all the variables are in place, locate 'Manual Deploy' > choose the master branch and click 'Deploy Branch'.
• Once the app is built (it may take a few minutes), click 'Open App' from the top of the page.
• Go back to the 'Deploy' tab and you can now click 'Enable Automatic Deployment'. Changes automatically deploy when you make a git push.

Config Vars Deploy

Credits

Code

• The project is broadly based on the I think therefor I blog project by the Code Institute and was used as a base for my project (https://github.com/Code-Institute-Solutions/Django3blog)
• The navbar was built using references from walkthrough project I think therefor I blog
• The Login/SignUp was build referenced by I think therefor I blog

Acknowledgments

• My husband Bernardo for his support and advice.
• Students of Code Institute on slack.