Empion Culture Matcher API

The Empion Culture Matcher API is a backend application that automates headhunting and connects applicants with the best company cultures. It provides a RESTful API to manage culture types, applicants, companies, and matches. The project aims to streamline the hiring process by matching applicants with companies based on their respective culture types.

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Running the API
  • API Documentation
  • Running Tests
• Docker
• Available Endpoints

Getting Started

Follow the instructions below to set up and run the Empion Culture Matcher API on your local machine.

Prerequisites

Before getting started, make sure you have the following software installed on your system:

• Ruby (recommended version: 3.0.3 or higher)
• Rails (recommended version: 7.0.6 or higher)
• PostgreSQL (recommended version: 12 or higher)

Installation

1. Clone the repository:

   git clone https://github.com/touseefmurtaza/culture-matcher-api
   cd culture-matcher-api

2. Install the required gems:

   bundle install

3. Set up the database:

   rails db:setup

Running the API

Without Docker

Update host in config/database.yml to:

localhost

Start the Rails server:

rails s

The API will be accessible at http://localhost:3000.

With Docker

1. Build and run the Docker containers:

docker-compose up --build

The API will be accessible at http://localhost:3000.

API Documentation

The API is documented using OpenAPI (Swagger). You can access the documentation at http://localhost:3000/api-docs.

Running Tests

To run the test suite:

rails test

Docker

The Empion Culture Matcher API can also be run inside Docker containers. The necessary configurations for Docker are provided in the Dockerfile and docker-compose.yml files.

Prerequisites

• Docker (recommended version: 20.10 or higher)

Installation with Docker

1. Clone the repository:

   git clone [email protected]:touseefmurtaza/culture-matcher-api.git
   cd culture-matcher-api

2. Build and run the Docker containers:

docker-compose up --build

3. Run tests in the Docker containers:

docker-compose run app rails test

The API will be accessible at http://localhost:3000.

Accessing the Rails Console

To access the Rails console within the Docker container, open a terminal and run the following command:

docker exec -it empion-culture-matcher-api-app-1 bash

Then, inside the container, run the following commands to set up the database:

rails db:create
rails db:migrate

Available Endpoints

The following endpoints are available in the API:

1. /api/v1/culture_types: Retrieve a list of culture types.

2. /api/v1/culture_types: Create a new culture type.

3. /api/v1/culture_types/:id: Retrieve details of a specific culture type.

4. /api/v1/culture_types/:id: Update a specific culture type.

5. /api/v1/culture_types/:id: Delete a specific culture type.

6. /api/v1/applicants: Retrieve a list of applicants.

7. /api/v1/applicants: Create a new applicant.

8. /api/v1/applicants/:id: Retrieve details of a specific applicant.

9. /api/v1/applicants/:id: Update a specific applicant.

10. /api/v1/applicants/:id: Delete a specific applicant.

11. /api/v1/companies: Retrieve a list of companies.

12. /api/v1/companies: Create a new company.

13. /api/v1/companies/:id: Retrieve details of a specific company.

14. /api/v1/companies/:id: Update a specific company.

15. /api/v1/companies/:id: Delete a specific company.

16. /api/v1/matches: Retrieve a list of matches.

17. /api/v1/matches: Create a new match.

18. /api/v1/matches/:id: Retrieve details of a specific match.

19. /api/v1/matches/:id: Update a specific match.

20. /api/v1/matches/:id: Delete a specific match.