uv sync

Screenshots

Screenshots coming soon!

📦 Installation

1. Install uv uv is used to manage dependencies and virtual environments.

pip install uv

or

curl -Ls https://astral.sh/uv/install.sh | sh

2. Clone the repository

git clone https://github.com/DevMohammad-SA/Twibble.git
cd Twibble

3. Install dependencies

uv sync

This will:

• Create a virtual environment automatically.
• Install all dependencies specified in pyproject.toml.
• Reproduce the exact development environment.

4. Set up environment variables

   Copy the example environment file and update it with your configuration:

   cp example.env .env
   

   Or create a .env file manually in the root directory with at minimum:

   DEBUG=True
   SECRET_KEY=your-secret-key-here
   ALLOWED_HOSTS=127.0.0.1,localhost
   

   Security Note: Generate a secure secret key for production. You can use python -c "from django.core.management.utils import get_random_secret_key; print(get_random_secret_key())" to generate one.

   See example.env for additional configuration options including database, email, and timezone settings.

5. Apply migrations and run server

   uv run python manage.py migrate
   uv run python manage.py runserver
   

6. Access the app Open your browser and go to http://127.0.0.1:8000/

7. Install pre-commit hooks

   uv run pre-commit run --all-files
   

To-Do

• Add likes and replies
• Add image uploads
• Add search functionality
• Create REST API (optional)
• Add notifications system
• Implement hashtags support
• Add Arabic locale support
• Implement bookmark support

Contributing

Contributions are welcome! Please see CONTRIBUTING for guidelines. Feel free to open issues or submit pull requests.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

Made with ❤️ by Mohammad Albuainain