/myHebrewDates

Automatically sync recurring Hebrew calendar events, like birthdays and anniversaries, to your digital calendar

Primary LanguageSCSSOtherNOASSERTION

My Hebrew Dates

MyHebrewDates is a web app for sharing Hebrew dates like birthdays, anniversaries, and yartzeit. It provides a subscribable feed for your calendar app, ensuring you never miss an important Hebrew date.

Built with Cookiecutter Django Black code style pre-commit.ci status

License: MIT

Contributors

Basic Commands

Installation

  1. Clone the repository:
git clone https://github.com/abe-101/myHebrewDates.git
cd myHebrewDates
  1. Create and activate a virtual environment:
python3 -m venv venv
source venv/bin/activate
  1. Install the local dependencies:
pip install -r requirements/local.txt
  1. Pre-Commit Install:
pre-commit install
  1. Create Database:
createdb --username=<USERNAME> my_hebrew_dates
  1. Create .env File and add these:
DATABASE_URL=postgres://<USERNAME>:<PASSWORD>@127.0.0.1:5432/my_hebrew_dates
CELERY_BROKER_URL=redis://localhost:6379/0
  1. Set up the database:
python manage.py makemigrations
python manage.py migrate
  1. Start the Server
python manage.py runserver

Setting Up Your Users

  • To create a normal user account, just go to Sign Up and fill out the form. Once you submit it, you'll see a "Verify Your E-mail Address" page. Go to your console to see a simulated email verification message. Copy the link into your browser. Now the user's email should be verified and ready to go.

  • To create a superuser account, use this command:

    $ python manage.py createsuperuser
    

For convenience, you can keep your normal user logged in on Chrome and your superuser logged in on Firefox (or similar), so that you can see how the site behaves for both kinds of users.