Skip to main content

Contributions

1. Clone the repository​

git clone https://github.com/AleksanderWojsz/django-admin-logs-viewer
cd django-admin-logs-viewer

2. Setup documentation locally​

cd documentation

Install Node.js packages

npm install

To start a local development server:

npm start

The documentation will be available at http://localhost:3000/django-admin-logs-viewer/

note

Deployment of the documentation is done automatically with every push to the main branch.
Automatic creation and upload of new PyPI package can be run from GitHub actions.

3. Setup Python environment​

pip install -r requirements.txt
pip install -e . # To automatically use locally developed django-admin-logs-viewer package

4. Create Django admin user and run example project​

example_project is available for testing. To set it up, do:

cd example_project

Apply migrations:

python manage.py migrate

To generate example logs:

python manage.py generate_logs

Create admin account:

python manage.py createsuperuser

Then run the development server:

python manage.py runserver

You can access the admin panel at http://127.0.0.1:8000/admin