DevIhor / Recruiter

Recruiter - is system that is supposed to help Recruiters and Talent Sources to find new candidates. It is Python Bootcamp Project. The project is just a REST API service with basic functionality.

Recruiter

Table of Contents

1. Project Description
2. Related Resources
3. Runtime Environment
4. Commands
5. Development Environment
6. Test Environment
7. Deployment instructions

Project Description

Recruiter is system that is designed to help Recruiters and Talent Sources to find new candidates. It is a Python Bootcamp Project. The project is just a REST API service with basic functionality.

Related Resources

The following list contains information of what is used in this project.

We are using Jira for Kanban board:

Link to the board

Runtime Environment

Environmental data is set up via .ENV files, that should have the following info:

DJANGO_SETTINGS_MODULE=config.settings
PROJECT_NAME=
SITE_URL=
SECRET_KEY=
ALLOWED_HOSTS=*
CORS_ALLOW_ALL_ORIGINS=YES
EMAIL_BACKEND=
DEFAULT_FROM_EMAIL=
REDIS_URL=
EMAIL_HOST_USER =
EMAIL_HOST_PASSWORD =
DEBUG_MODE=YES

Commands

# Run to create migrations
python manage.py makemigrations

# Run apply migrations
python manage.py migrate

# Collect static into Storage
python manage.py collectstatic --no-input

# Create superuser
python manage.py createsuperuser

# To enter interactive Django shell
python manage.py shell

# To run a development server
python manage.py runserver

# To run a celery worker
celery -A config.celery worker --loginfo=info

Development Environment

In order to test this project on your local machine, do the following:

• Clone this repo to your local machine using the following command:

git clone https://github.com/DevIhor/Recruiter.git

• Navigate into the folder and install the requirements by running the following command:

cd Recruiter && pip install -r requirements/dev.txt

• Make the migrations to prepare the database:

python manage.py migrate

• Run the server by the following command:

python manage.py runserver

The project should be available on your localhost, check the output of your command line for the details.

Test environment

We are using coverage.py for testing and coverage. Run the tests by running:

coverage run -m pytest
coverage report

Deployment instructions

Live server is available at this link.