Merge pull request #22 from aviiciii/dev

Code Refactor and Readme added
aviiciii · Jun 2, 2023 · ede4cd3 · ede4cd3
2 parents ee6e08e + 5a258d4
commit ede4cd3
Show file tree

Hide file tree

Showing 24 changed files with 45 additions and 663 deletions.
diff --git a/.gitignore b/.gitignore
diff --git a/README.md b/README.md
@@ -1,3 +1,44 @@
-# shortlink
+# Shorten!
 
-NOTE: Don't make in public. KEYS EXPOSED
+The Shorten Web Application allows users to generate shortened URLs for their long URLs. It is a simple and easy-to-use tool built using HTML, CSS, and JavaScript.
+
+## Features
+
+- Generates short URLs for long URLs to make them more manageable and shareable.
+- Uses the short.io API service to handle URL shortening and redirection.
+- Provides a clean and intuitive user interface for quick URL shortening.
+
+## Prerequisites
+
+Before getting started, make sure you have the following:
+
+- A domain or subdomain to host the application.
+- Registration of your domain/subdomain with short.io to obtain a public API key.
+
+## Installation and Setup
+
+1. Fork this repository to your GitHub account.
+2. Clone the forked repository to your local machine.
+3. Register your domain/subdomain with short.io to generate a public API key.
+4. Open the `assets/script.js` file in a text editor.
+5. Replace the placeholder API key in the `'authorization'` field with your short.io API key.
+6. Rename the domain `'link.laavesh.ml'` to your own domain or subdomain in the following files:
+   - `index.html`
+   - `assets/script.js`
+
+## Usage
+
+1. Deploy the application to your domain or subdomain.
+2. Visit your domain or subdomain in a web browser.
+3. Enter a long URL in the input field.
+4. Click on the "Shorten" button.
+5. The application will generate a shortened URL using the short.io API and display it to the user.
+6. Copy the shortened URL and use it wherever you need.
+
+## Contributing
+
+Contributions are welcome! If you have any suggestions, improvements, or bug fixes, feel free to create a pull request.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
diff --git a/assets/script.js b/assets/script.js
@@ -21,6 +21,7 @@ document.getElementById("myinput").onclick = function () {
 
     // data to be sent to the API
     var data = {
+        // domain -- change here if you want to use your own domain
         domain: "link.laavesh.ml",
         originalURL: link,
         allowDuplicates: false,
@@ -37,6 +38,7 @@ document.getElementById("myinput").onclick = function () {
         headers: {
             accept: "application/json",
             "Content-Type": "application/json",
+            // API key -- change here if you want to use your own API key (public key)
             authorization: "pk_ynFkEXQHXdWrijOF",
         },
         body: JSON.stringify(data),

diff --git a/edit.py b/edit.py
diff --git a/short/db.sqlite3 b/short/db.sqlite3
diff --git a/short/manage.py b/short/manage.py
diff --git a/short/short/__init__.py b/short/short/__init__.py
diff --git a/short/short/asgi.py b/short/short/asgi.py
diff --git a/short/short/settings.py b/short/short/settings.py
diff --git a/short/short/urls.py b/short/short/urls.py
diff --git a/short/short/wsgi.py b/short/short/wsgi.py
diff --git a/short/transfer/__init__.py b/short/transfer/__init__.py
diff --git a/short/transfer/admin.py b/short/transfer/admin.py
diff --git a/short/transfer/apps.py b/short/transfer/apps.py
diff --git a/short/transfer/migrations/__init__.py b/short/transfer/migrations/__init__.py
diff --git a/short/transfer/models.py b/short/transfer/models.py
diff --git a/short/transfer/static/transfer/copy.png b/short/transfer/static/transfer/copy.png
diff --git a/short/transfer/static/transfer/favicon.png b/short/transfer/static/transfer/favicon.png
diff --git a/short/transfer/static/transfer/script.js b/short/transfer/static/transfer/script.js