Project OSUS - Open Source URL Shortener

Overview

Welcome to Project OSUS, an open-source URL shortener built using Flask, Python, and MongoDB. This project is part of Hacktoberfest 2024, encouraging contributions from developers and non-developers alike. The goal is to provide a simple, easy-to-use URL shortening service while fostering collaboration in the open-source community.

Installation

To get started with Project OSUS, follow these steps:

1. Fork the repository on GitHub.
2. Clone the repository using the command:

git clone https://github.com/your-username/project-osus.git

3. Set up a virtual environment (optional but recommended):

python -m venv venv

4. Activate the virtual environment:

source venv/bin/activate

5. Install the required dependencies:

pip install -r requirements.txt

6. Set up your MongoDB connection string in a `.env` file:

MONGO_PATH='localhost'
MONGO_PORT=27017

7. Run the application:

flask run

8. Access the application at:

http://localhost:5000

Features

• Shorten long URLs with ease.
• Automatic redirection to the original URL.
• Simple and intuitive user interface.

Contributing

We welcome contributions from developers of all skill levels! Whether you're fixing bugs, adding new features, or improving documentation, all help is appreciated. To contribute:

1. Fork the repository on GitHub.
2. Clone your forked repository:

git clone https://github.com/your-username/project-osus.git

3. Create a new branch for your changes:

git checkout -b feature-branch

4. Make your changes and commit them:

git add .
git commit -m "Description of your changes"

5. Push your changes:

git push origin feature-branch

6. Create a pull request on GitHub with a description of your changes.

Frequently Asked Questions (FAQ)

Contact Us

If you have any questions or need further assistance, feel free to reach out to us via the following platforms:

• GitHub: GitHub Repository