Evally

A simple web application to manage periodic skills evaluations of employees and recruitment evaluations of candidates.

Introduction
Features
Requirements
Instalation
Feedback
Contributing
License

Introduction

Manage your employees by tracking their skills development based on own customized questionnaires. Evally, built with Ruby on Rails and Vue.js as Single Page Application, can be your basic tool for targeting career paths of your employees and observing the human potential of your company.

Setup this app together with Evally Recruitable to extend possibilities and store recruitment applications in one place, in a clear way.

Features

Core module

A few of the things that you can do with Evally:

prepare own customized questionnaires
use a three stars rating, 'yes or no' option or text to evaluate employee
manage hired and archived employees
save evaluation drafts for further modifications
track and get notifications about upcoming evaluations
archive users activities
share evaluations by unique and safe link
search employees by skills
present the analytics about employees, employment changes and evaluations on charts
use one of two available languages: Polish, English
as an admin delegate employee's evaluations to user with evaluator role

Recruitable module (optional)

More things you can do with Evally Recruitable extension:

list all recruitment applications with simple filters and search field
present necessary information in a straight way
upload and store attachments
mark recruitment applications with statuses
assign evaluators to candidate
evaluate documents based on customized templates
add comments to candidate's profile

Requirements

Ruby 2.7.0
PostgreSQL 10.6+
Node.js 6.14.4+
Yarn 1.x+
Docker

Instalation

1. Pull the repository

git clone https://github.com/railwaymen/evally.git

2. Install application dependencies

Run the following commands to install all required dependencies.

bundle install
yarn install

3. Update seeds.rb file

Update db/seeds.rb file to provide credentials for user who will be created during database setup (look at next step).

User.find_or_create_by!(email: 'admin@example.com') do |u|
  u.password = 'password'
  u.first_name = 'John'
  u.last_name = 'Doe'
  u.role = 'admin'
end

4. Create and setup the database

Run the following commands to create and setup the database.

bundle exec rake db:create
bundle exec rake db:setup

5. Run Sidekiq

Run Sidekiq for background jobs processing. It is important to provide data synchronization between core module and extensions.

# run sidekiq
bundle exec sidekiq

6. Start the Rails server

You can start the development rails server in the way given below:

# run rails server
bundle exec rails s

And now you can visit the site with the URL http://localhost:3000

If you want to use live code reloading, or you have enough JavaScript that on-demand compilation is too slow, you'll need to run:

# run webpack dev server
./bin/webpack-dev-server

Run the app using docker-compose*

1. Create docker network

docker network create evally_network --subnet 172.24.24.0/24

2. Create images for evally_recruitable app

Go to evally_recruitable project directory and run:

docker-compose build

3. Create images for evally_core app

Go to evally project directory and run:

docker-compose build

4. Start the app

docker-compose up

5. Setup evally_core database

docker exec -it evally_core_app rails db:create db:schema:load db:seed

6. Setup evally_recruitable database

docker exec -it evally_recruitable_app rails db:create db:schema:load db:seed

* work in progress

Feedback

Feel free to send us feedback. Feature requests are always welcome. If you wish to contribute, please take a quick look at the guidelines!

If you notice any bugs in the app, see some code that can be improved, or have features you would like to be added, please create a bug report or a feature request!

A good bug report must include the following four things:

The steps to reproduce the bug: Give detailed steps on how to reproduce the problem
The expected behavior of the application: It’s important to include the result you’re expecting, as it might differ from how the program was designed to work.
The observed behavior of the application
Additional info: ... like some links, images etc.

Contributing

We encourage you to contribute to Evally! See CONTRIBUTING for guidelines about how to proceed.

Thank you for your interest in contributing! Please feel free to put up a PR for any issue or feature request.

If you want to open a PR that fixes a bug or adds a feature, then we can't thank you enough! It is definitely appreciated if an issue has been created before-hand so it can be discussed first.

License

Evally is released under the GNU GPL license.

railwaymen / evally