{"id":22957102,"url":"https://github.com/kenmwaura1/zoo-gram","last_synced_at":"2025-04-02T01:33:18.080Z","repository":{"id":100856030,"uuid":"417455366","full_name":"KenMwaura1/zoo-gram","owner":"KenMwaura1","description":"a Django clone of the website for the popular photo app Instagram","archived":false,"fork":false,"pushed_at":"2021-10-19T21:58:27.000Z","size":5957,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-07T16:39:19.374Z","etag":null,"topics":["cloudinary-sdk","django-application","mdbootstrap","postgresql"],"latest_commit_sha":null,"homepage":"https://zoo-gram.herokuapp.com/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KenMwaura1.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-15T10:14:04.000Z","updated_at":"2021-10-28T20:03:44.000Z","dependencies_parsed_at":"2023-06-02T04:15:22.744Z","dependency_job_id":null,"html_url":"https://github.com/KenMwaura1/zoo-gram","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2Fzoo-gram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2Fzoo-gram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2Fzoo-gram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2Fzoo-gram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KenMwaura1","download_url":"https://codeload.github.com/KenMwaura1/zoo-gram/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246739027,"owners_count":20825875,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloudinary-sdk","django-application","mdbootstrap","postgresql"],"created_at":"2024-12-14T17:15:18.825Z","updated_at":"2025-04-02T01:33:18.075Z","avatar_url":"https://github.com/KenMwaura1.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zoo-gram\na Django clone of the website for the popular photo app Instagram.\n\n[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)\n\n![](static/images/Zoo-Gram.gif)\n\n## User stories\nAs a user of the application I should be able to:\n\n1. Sign in to the application to start using. :heavy_check_mark:\n2. Upload my pictures to the application. :heavy_check_mark:\n3. See my profile with all my pictures. :heavy_check_mark:\n4. Follow other users and see their pictures on my timeline. :heavy_check_mark:\n5. Like a picture and leave a comment on it. :heavy_check_mark:\n\n## Feature A: Image Model :heavy_check_mark:\nYour Project should contain an Image model with the following properties:\n\n1. Image\n2. Image Name.\n3. Image Caption.\n4. Profile Foreign key\n5. Likes\n6. Comments\n\n\n## Feature B: Profile model :heavy_check_mark: \nCreate the Profile model with the following properties:\n\n* Profile Photo\n* Bio\n* Remember to make migrations to your database when you change the properties of the model.\n\n## Feature C: Image Model methods \nYour Image model should contain at least the following methods:\n\n* save_image() - Save an image to the database.\n* delete_image() - Delete image from the database.\n* update_caption() - Update image caption in the database.\n\nYou should write tests for each of these methods and make sure you implement error handlers to prevent your application from crashing.\n\n## Feature D: Profile model methods.\n* You must implement the save, update and delete methods in the models.\n* Make sure you write tests for each method\n\n## Feature E: Search Functionality\nYour project must have a search form that when submitted calls a search function in the view function and redirects to a search results page.\n\n## Feature F: Image Details\nWhen a user clicks on an Image he/she should be redirected to where the image is displayed and should also see the details of the Image.\n\n## Feature H: an Authentication system\nYour application should have a solid authentication system that allows users to sign in or register into the application before using it. When a user registers with your application they should receive a confirmation email.\n\n## Showcase\n\n![screenshot of app running](static/images/Screenshots/2021-10-20_00-45-zgram.png)\n\n![](static/images/Screenshots/2021-10-20_00-41-zgram.png)\n\n![](static/images/Screenshots/2021-10-20_00-42-zgram.png)\n\n![](static/images/Screenshots/2021-10-20_00-46-zgram.png)\n\n![](static/images/Screenshots/2021-10-20_00-47-zgram.png)\n\n![](static/images/Screenshots/2021-10-20_00-48-zgram.png)\n\n## Live Site\n\n[link to deployed site](https://zoo-gram.herokuapp.com/)\n\n## Setup Instructions / Installation\n\n### Getting Started\n\n### Prerequisites\n\n- Python and pip (I am currently using 3.9.7) Any version above 3.7 should work.\n* Git installed on your machine\n* Code editor/ IDE\n\n### Installation and Running the App\n\n1. Clone GitHub repository\n\n    ```shell\n    git clone https://github.com/KenMwaura1/zoo-gram\n    ```\n\n2. Change into the folder\n\n    ```shell\n   cd zoo_gram\n    ```\n\n3. Create a virtual environment\n\n   ```shell\n      python3 -m venv venv \n   ```\n\n    * Activate the virtual environment\n\n   ```shell\n   source ./bin/activate\n   ```\n\n* If you are using [pyenv](https://github.com/pyenv/pyenv):\n\n  3a. Create a virtualenv\n\n   ```\n       pyenv virtualenv zoo_gram\n   ```\n\n  3b. Activate the virtualenv\n\n   ```\n   pyenv activate zoo_gram\n   ```\n\n4. Create a `.env` file and add your credentials\n\n   ```\n   touch .env \n   ```\n\n   OR Copy the included example\n\n    ```\n    cp .env-example .env \n    ```\n\n5. Add your credentials to the `.env` file\n\n    5a. Create a [free cloudinary account](https://cloudinary.com/) and get your credentials to enable photo uploading deployed.\n\n   OR\n\n    5b. Uncomment **line 15**  and **line 57** in **z_gram/models.py** to save and serve images locally. \n    \n\n\n6. Migrate your database\n    ```shell\n    python manage.py migrate\n    ```\n\n7. Install the required dependencies\n\n   ```shell\n   pip install -r requirements.txt\n   ```\n\n8. Make the shell script executable\n\n    ```shell\n   chmod a+x ./run.sh\n    ```\n\n9. Run the app\n\n    ```shell\n   ./run.sh\n    ```\n\n   OR\n   run with python\n\n    ```shell\n   python manage.py runserver\n    ```\n\n## Tests\n\n* To run the tests:\n\n    ```shell\n  python manage.py test\n    ```\n\n## Technologies used\n\n* Python-3.9.7\n* Django web framework\n* PostgreSQL\n* Cloudinary\n* Bootstrap(Material Bootstrap 4)\n* HTML5\n* CSS3\n\n## Author\n\n[Ken Mwaura](https://github.com/KenMwaura1)\n\n\n## LICENSE\n\nMIT License\n\nCopyright (c) 2021 Kennedy Ngugi Mwaura\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenmwaura1%2Fzoo-gram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkenmwaura1%2Fzoo-gram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenmwaura1%2Fzoo-gram/lists"}