diff --git a/README.md b/README.md index 5feae99..527dfc5 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,37 @@ Example of using [Django Vite](https://github.com/MrBin99/django-vite) module into a basic Django project. -# Advice +## Advice - This is a really basic example to help people figure out how to setup the module. - Don't use this project as is. - Use it as an helper to begin with and build your configuration upon it. + +## Installation + +Make sure you have Python 3.9.7 or greater and Node 18.70 or greater installed. + +1. Install Node dependencies: + ``` + npx yarn install + yarn install + ``` + +2. Install Python dependencies: + ``` + python -m venv .venv + source .venv/bin/activate + pip install poetry + poetry install + ``` + +## Run Django and Vite + +1. Open a terminal window and run: + ``` + npm run dev + ``` +2. Open a new terminal window and run: + ``` + python manage.py runserver + ```