Limelight
limelight aims to streamline the end-to-end recruiting process so that recruiters and hiring managers can focus on what truly matters: their candidates.
Synopsis
Current Standard
Any company starting out will quickly understand how overwhelming resume submissions can be. Job seekers will apply to all available positions regardless of their qualifications. Hiring managers have to look through and read hundreds of resumes that are being submitted for multiple positions. They have to manually organize and sort all the resumes that they read through to determine the most qualified applicants. This makes sorting through resumes and finding the right candidate that much harder.
Goals
- Eliminate the stress of the hiring processes for all parties involved and bring together talented individuals.
- Give applicants an easy and pleasant experience when submitting resumes.
- Provide an easy platform for hiring managers to screen applicants.
- Connect employers with great candidates that would best match their company.
Functional Requirements
- Create a company profile
- Create a job posting
- Ranking Applicants
- Screen/Approve/Reject Applications
- Submitting an application
- Notifications
Non-Functional Requirements
- Performance: the system should be quick and dynamic so when a user chooses to view applicants for a position, they should load quickly and in order.
- Error Handling: the system should provide error handling and necessary validations for all use cases.
- Accessibility: The system must be accessible from all common web browsers, operating systems, and mobile devices.
- Help: They system should provide useful tips and hints on major functionalities.
- Data Storage: all applications should be stored in a database and maintain old application for archiving purposes.
- Security: the system should maintain a high level of data security due to the nature of handing a large amount of personal data on applicants.
Tools
We are using Ruby on Rails with Bootstrap.
Necessary Technologies:
- HTML
- SASS & Bootstrap 4
- Javascript
- Ruby 2.5
- Rails 5 (MVC, ActiveRecord ORM)
- PostgreSQL
Integration & Services:
- Codacy
- Travis
- AccessLint
- Slack/Github Webhooks
Project Management Tools:
Architecture
Our website uses a Model-View-Controller (MVC) architecture pattern in accordance to the pattern in Ruby on Rails.
Design
About Us (pictures are not real)
Applicant's Perspective - Applying to a Job
Development
How to develop
In order to run the application locally, you need to install:
- C Compiler (on OS X, type:
xcode-select --install
) - Ruby 2.5.0 (on OS X with rbenv, type:
brew update; brew upgrade ruby-build; rbenv install 2.5.0
) - PostgreSQL 10.1 (on OS X with brew, type:
brew install postgresql
and follow the instructions to run PostgreSQL locally) - Redis (on OS X with brew, type:
brew install redis
and follow the instructions onbrew info redis
to run Redis locally)
Then type bundle install
, then rails db:setup
and run the server with rails server
.
How to contribute
Push your branch to the project and open a pull request against master.
Heroku will magically create an instance of the application with your code so you (and your co-workers) can test your changes live! ✨ ✨ ✨
Once your PR is accepted and merged into master, the code will be automatically deployed to production and will show up on production.
How to write code
Follow some common-sense rules for maintainability and readability:
- keep lines below 80 characters
- keep files below 100 lines
- keep the Gemfile short and documented
- keep commits short and documented
- keep the main gems up to date
- keep the user interface consistent
- use modules/subfolders to distinguish features
- don’t use flash messages, create a proper page instead
- don’t write production API/secret keys in your code
- don’t write code you wouldn’t want to read
Documentation
Full documentation of the application:
- Request for Proposal
- Requirement Analysis Document
- Scenarios
- Use Cases
- Database Schema
- List of Methods
- List of Objects
- Class Diagram
- Sequence Diagrams
Contributors
License
Limelight's license and user policy will be available soon.