myHebrewDates Project README

The current README is the defualt from the cookiecutter-django project

Things to include:

About the project
Credtis to contributors
how to set up locally

Jun 28 '23 03:06 abe-101

hello @abe-101 please assign me this issue i will update the README.md very soon Thank You!

Oct 12 '23 04:10 seabeePraveen

as mentioned in the above issue "credits to the contributers" do u mean to add their photo in the README.md itself or anything more ?

Oct 12 '23 04:10 seabeePraveen

Adding their GitHub handle to readme is fine

Oct 12 '23 04:10 abe-101

@abe-101 i have cloned the repo and i have installed all the packages into my venv but i couldn't found the env files what do u want me to do ? like in the setup docs how do u want me to go with it? if env files are missing? also provide a brief about the project so i could make this way better even from your side

Oct 12 '23 05:10 seabeePraveen

these are the modifications that i have made: and also docs for the setup: so if there's any modifications to be done please let me know and also as the env files are missing so i didn't included that part in the setup and this will throw a error tell me what should i have to do

Oct 12 '23 05:10 seabeePraveen

the .env should look like:

export DATABASE_URL=postgres://<USERNAME>:<PASSWORD>@127.0.0.1:5432/my_hebrew_dates
export CELERY_BROKER_URL=redis://localhost:6379/0

Oct 12 '23 05:10 abe-101

also for local development it should be:

pip install -r requirements/local.txt

as requirements/local.txt includes whats in requirements/base.txt

Oct 12 '23 05:10 abe-101

take a look at https://cookiecutter-django.readthedocs.io/en/latest/developing-locally.html

off the top of my mind the steps should be (I may be missing some):

clone the repo
cd into repo
create python env
install dependancys
run pre-commit install
create a new db table with createdb --username=<USERNAME> my_hebrew_dates
create a .env file
python manage.py migrate (No need to run makemigrations unless a change was made)

Oct 12 '23 06:10 abe-101

hello @abe-101 once check these and let me know if any changes are required :

Oct 12 '23 16:10 seabeePraveen

@seabeePraveen can you make a PR and I'll review the changes?

Oct 12 '23 16:10 abe-101

yeah okay i will do it now please check it

Oct 12 '23 16:10 seabeePraveen

PR was send please review it and let me know

Oct 12 '23 16:10 seabeePraveen

let me know if any changes are required Thank You!

Oct 12 '23 17:10 seabeePraveen