Noteshrinker - Django

What is this?

This a webservice, which is designed to help people keep their notes clean and store them in pretty PDF's.

It shrinks & prettifies the images uploaded, which makes them much easier to work with.

Example

Look at the image provided: Better resolution is available in the "example" folder of this repo. It is not perfect example, it is the one done with the defaults, yet it can be made better by tweaking settings.

What does it look like?

How do I launch it?

Using Python

First of all, get Python 3.10.

Traditional flow (python3 + pip3 + virtualenv)

1. Python 3
2. Pip
3. Then, clone this repo (attention! it will be cloned to the current directory, so make sure you do it in some kinda documents or special one) git clone https://github.com/delneg/noteshrinker-django/
4. Then, cd noteshrinker_django
5. Optionally, create and activate virtualenv: virtualenv venv && source venv/bin/activate
6. Install dependencies: pip3 install -r requirements.txt
7. Tweak the settings in the bottom of the settings.py file.
8. Finally, from the root directory of the project: python3 manage.py migrate and python3 manage.py runserver
9. Navigate to http://localhost:8000 in your browser!

uv flow (recommended)

1. Install uv
2. Clone this repo: git clone https://github.com/delneg/noteshrinker-django/
3. Then, cd noteshrinker_django
4. Initialize a uv project: uv init
5. Install dependencies from requirements: uv add -r requirements.txt
6. Tweak the settings in the bottom of the settings.py file.
7. Run migrations: uv run python manage.py migrate
8. Start server: uv run python manage.py runserver
9. Navigate to http://localhost:8000 in your browser!

Using Docker (not for production)

Make sure you have Docker installed.

1. Clone this repository:
   git clone https://github.com/delneg/noteshrinker-django/
2. cd into the newly created directory:
   cd noteshrinker-django
3. Build the Docker container:
   docker build -t noteshrinker .
4. Run the container:
   docker run -p 8000:8000 --rm noteshrinker
   The container will listen on port 8000 (bound to internal port 8000) and will be removed after use (--rm). The server should be up-and-running immediately but it won't tell you. Just go to the next step.
5. Navigate to http://localhost:8000 in your browser!

License

MIT

Contribution

Feel free to contribute, I will review all responses.

Locales

Currently the app has Russian,English, Portugese (by https://github.com/Qu4tro), Chinese (by https://github.com/gaoyaoxin) languages availiable. Feel free to add your locale - I'll appreciate it!

To add a locale: Add a locale to LANGUAGES in settings.py file

Do django-admin makemessages, edit the django.po file in locale/{local_code}/LC_MESSAGES/

Then run django-admin compilemessages