Code Monkey home page Code Monkey logo

shortit's Introduction

ShortIt

ShortIt is a web application crafted to simplify the process of URL shortening. With a clean, intuitive interface, ShortIt makes it easy to convert long URLs into short, manageable links. This is particularly useful for sharing links in a more user-friendly manner across different platforms.

Installation

This project is built with Django and uses Pipenv for managing dependencies. Follow these steps to get it running on your local machine:

  1. Clone the repository to your local machine using git clone https://github.com/Pokymon/shortit.git.

  2. Navigate to the project directory with cd ShortIt.

  3. Copy settings.py.example to settings.py and update the environment variables to match your setup.

  4. Install Pipenv if you haven't already with pip install pipenv.

  5. Install project dependencies with Pipenv by running pipenv install.

  6. Enter the Pipenv shell using pipenv shell.

  7. Run database migrations with python manage.py migrate.

  8. Create an admin user for the Django admin interface using python manage.py createsuperuser.

  9. Start the local development server with python manage.py runserver.

Now you can access the ShortIt web application locally.

Contributing

We welcome contributions to ShortIt. Feel free to fork the repository or submit a pull request. We appreciate any help, whether it's fixing bugs, improving documentation, or suggesting new features.

License

ShortIt is distributed under the MIT License. See LICENSE file for more information.

Contact

If you have any questions or suggestions, feel free to reach out at [email protected].

shortit's People

Contributors

pokymon avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.