Project README

[abe-101]

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

[seabeePraveen]

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

[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 ?

[abe-101]

Adding their GitHub handle to readme is fine

[seabeePraveen]

@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

[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

[abe-101]

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

[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

[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):

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

[seabeePraveen]

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

[abe-101]

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

[seabeePraveen]

yeah okay i will do it now please check it

[seabeePraveen]

PR was send please review it and let me know

[seabeePraveen]

let me know if any changes are required
Thank You!