Photobook is a Django-based browser extension designed to simplify the process of bookmarking and saving images from any website. With Photobook, users can create an account, log in, and effortlessly save their favourite images for later viewing. This extension streamlines image bookmarking, making it a convenient tool for anyone who loves collecting and organizing visual content.
To set up Photobook, follow these steps:
- Python: Ensure you have Python (3.6 or higher) installed on your system.
- Clone the Photobook repository to your local machine:
git clone https://github.com/Codestronomer/Photobookmarker
- Navigate to the project directory:
$ cd photobookmarker
- Install the required Python packages:
pip install -r requirements.txt
- Create the database and apply migrations:
python manage.py migrate
- Start the development server:
python manage.py runserver
- Access the Photobook in your web browser at
http://localhost:8000/
.
Using Photobook is simple:
-
Create an Account or Log In: If you're a new user, sign up for an account to access the full functionality of Photobook. Existing users can simply log in.
-
Install the "Bookmark It!" Button: Drag the "bookmark it!" button to your browser's bookmark toolbar. This button will serve as your quick access to saving images.
-
Bookmark Images: Whenever you find an image you want to save, click the "bookmark it!" button in your browser. This will initiate the image-saving process.
-
Select and Save: On the webpage with the desired image, select the image you want to bookmark. Photobook will capture your selection and prompt you to submit the form.
-
Access Your Image Collection: Log in to your Photobook account anytime to view your saved images. You can organize, categorize, and manage your collection effortlessly.
Photobook is built using the following technologies:
- Django: The web framework that powers the server side of the extension.
- HTML and CSS: For the front-end interface and user interaction.
- Browser Extension: To provide seamless integration with web browsers.
- Database: A database system (SQLite) to store user accounts and bookmarked images.
Photobook offers several features to enhance your image bookmarking experience:
- User Authentication: Create a secure account and log in to access your saved images.
- One-Click Bookmarking: Use the "bookmark it!" button to save images quickly and easily.
- Image Selection: Select specific images on a webpage for bookmarking.
- Image Organization: View, manage, and categorize your saved images within the extension.
- Browser Compatibility: Compatible with popular web browsers, including Chrome, Firefox, and Edge.
We welcome contributions from the community to make Photobook even better. If you'd like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and submit a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
If you have any questions, or suggestions, or encounter any issues, please feel free to contact us at [email protected].
Start saving and organizing your favourite images with Photobook today!