README clarity

This commit is contained in:
Caretaker0699 2023-06-29 17:07:17 -07:00
parent a0109f0726
commit 69cd65fbf0

View File

@ -1,65 +1,29 @@
# OVERVIEW
HEARTILY is a Christian aggregated job board that tries to only list jobs from companies that adhere to Biblical principles and the following Statement of Faith: https://shilohcode.com/
Heartily: Servant Hearts, Working for the Lord. The Biblically based job search board.
Listings are updated hourly.
"23 Whatever you do, do your work HEARTILY, as for the Lord and not for people, 24 knowing that it is from the Lord that you will receive the reward [b]of the inheritance. It is the Lord Christ whom you serve." (Colossians 3:23 NASB)
These is the current query used to filter the results:
(it+OR+technology+OR+developer+OR+software)+AND+(bible+OR+christian+OR+jesus+OR+god)+-LDS+-%22Latter-Day+Saints%22
Heartily is a Christian aggregated job board that aims to provide job listings exclusively from companies that align with Biblical principles and the Statement of Faith outlined at shilohcode.com/about.
This is a Shiloh community supported project, if you see listings that are not appropriate please use the report button so we can improve the query filtering.
# Features
Our hope is that this app helps accelerate your calling in Christ Jesus, see Colossians 3:23-24 NASB.
Filtered Job Listings: Heartily attempts to aggregate job listings using a custom query to filter for only relevant roles.
# Flask App Deployment with Gunicorn and Caddy
The current ies used to refine the results include:
(it OR technology OR developer OR software) AND (bible OR christian OR jesus OR god) -LDS -"Latter-Day Saints".
This repository provides a sample Flask app deployment setup using Gunicorn as the application server and Caddy as a reverse proxy.
Regular Updates: Listings on Heartily are updated hourly, ensuring that you have access to the most recent job opportunities.
## Prerequisites
Report Listings: If you come across any listings that are not in line with our mission or principles as believers, we encourage you to use the report button so that we can continuously improve the filtering mechanism.
- Python 3.x
- pip package manager
- Gunicorn
- Caddy
# Get Involved
We welcome your participation and contributions to make Heartily even better. If you have suggestions, ideas, or would like to report any issues, please feel free to reach out. support@shilohsoftware.com or raise an issue on githaven.
## Installation
# Our Hope
1. Clone the repository:
Our hope is that Heartily will serve as a valuable resource to accelerate your vocational calling in Christ Jesus. As you navigate your career and seek job opportunities, remember the words of Colossians 3:23-24 (NASB).
May Heartily be a platform that aligns with our Christian values and supports you in finding God honoring employment.
2. Install the required dependencies:
3. Install Gunicorn.
4. Install Caddy by following the official Caddy installation guide for your operating system: [Caddy Installation Guide](https://caddyserver.com/docs/install)
## Configuration
1. Create a `Caddyfile` configuration file in the same directory as your `app.py` file. Here's an example `Caddyfile` configuration:
yourdomain.com {
reverse_proxy localhost:8000
}
Replace `yourdomain.com` with your actual domain name.
2. Customize the `gunicorn_config.py` file according to your app's requirements.
## Deployment
1. Start your Flask app with Gunicorn using the `gunicorn_config.py` file. Run the following command in the terminal:
This will start the Gunicorn server and bind it to `localhost:8000` by default.
2. Start the Caddy server by running the following command in the terminal:
Caddy will read the `Caddyfile` configuration and start serving your Flask app through the reverse proxy.
3. Access your Flask app by visiting `yourdomain.com` in your web browser. Replace `yourdomain.com` with your actual domain or hostname.
## License
TBA