Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation on how to install requirements and run the project #6

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation on how to install requirements and run the project #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```