Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jimbonothing64 authored Dec 23, 2023
1 parent b0e5654 commit 4e34f73
Showing 1 changed file with 15 additions and 9 deletions.
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,36 @@
# Minimise Python Tutor
Python code can become too long for Python Tutor due to comments, docscrings and extra spaces.
Minimise for Python Tutor shortens code and generates a sharable link for long Python code.

Sometimes Python code examples are too long to create a sharable python tutor link due to long docstrings or whitepsace.
Minimise for Python Tutor shortens code and generates a sharable Python Tutor link for long Python3 code.
# Using
1. Enter your code into the textbox.
2. If your code is very long tick `tiny indent` to minimise it further.
3. Press `Get link`.
4. Your minimised code will apear below. You can either `Copy` the link or `Visit` it directly.
5. If you want to see your minimised code You can press `Show Code`.

## Runing
# About
The frontend, in `/app`, is made with sveltekit (TypeScript). It uses SSR, is quick to build an intuitive UI with using flowbite and handles forms intuitively.
The backend, in `/api`, is made with fastAPI (Python) because the minimisation library is in python and it provides built in data validation.

### API
# Runing
You need to run both the API and the App.

### API
To get started activate venv (optional):

```
python -m venv env
source env/bin/activate
```

Starting server:

Starting the server:
```
pip install -r api/requirements.txt
cd api
uvicorn main:app --reload
```

### App

```
cd app
pnpm install
Expand Down

1 comment on commit 4e34f73

@vercel
Copy link

@vercel vercel bot commented on 4e34f73 Dec 23, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.