JobRecorder 🌐

Simplify Your Job Application Process

Overview

JobRecorder aims to empower job seekers by providing a comprehensive tool to manage their job applications more efficiently, reducing the stress and disorganization often associated with the job search process.

How to use JobRecorder

Watch the Video

For a comprehensive guide, see the full interactive version here 👈.

Entity-Relationship Diagram (ERD)

Our application's database schema is visualized in the Entity-Relationship Diagram (ERD) below. This diagram provides a clear overview of the tables, their fields, and the relationships between them, facilitating a better understanding of how data is interconnected within our application.

Setup

Dependencies

• Active Storage
• AWS SDK for Ruby
• Omniauth-Google-OAuth2
• Ruby OpenAI
• Chartkick
• Action Mailer
• Action Mailbox

Installation

1. Clone the repository and install dependencies:

   git clone https://github.com/andrewp8/JobRecorder.git
   cd JobRecorder
   bundle install
   rails dev:reset  # Seeds the database with sample data
   rails active_storage:install
   rails db:migrate

2. Create a .env file:

   touch .env

   • Inside the .env file, define your credentials using key-value pairs, one per line. Here's the format:
   • API_KEY=your_secret_api_key

3. Once you have met the prerequisites, you can start the Rails development server by running the following command in your terminal:

   rails s

Contributing

• Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
• Follow Rails Naming Conventions: Ensure that all code contributions adhere to the Rails naming conventions for classes, modules, table names, and associations. This consistency is crucial for maintaining code clarity and efficiency within the framework.

Frequently Asked Questions (FAQ)

Q: What should I do if I encounter an error stating that the master key is missing?

A:

• Delete the existing credentials.yml.enc file to allow for the generation of new credentials: rm config/credentials.yml.enc.
• Open your credentials for editing with your preferred editor, e.g., EDITOR="code --wait" rails credentials:edit.
• After updating your credentials, save and close the editor to generate a new master.key.
• Securely configure the new master.key in your environment variables, but do not add it to version control.
• Remember to back up any essential data before making these changes.