{"id":22957098,"url":"https://github.com/kenmwaura1/zoo-awwards","last_synced_at":"2026-05-10T19:21:42.627Z","repository":{"id":100856037,"uuid":"420075502","full_name":"KenMwaura1/zoo-awwards","owner":"KenMwaura1","description":"A Django application like Awwards (It doesn't necessarily have to be exactly the same). The application will allow a user to post a project he/she has created and get it reviewed by his/her peers.","archived":false,"fork":false,"pushed_at":"2021-10-26T22:48:37.000Z","size":5432,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-07T16:39:18.502Z","etag":null,"topics":["django","django-rest-framework","mdbootstrap","postgresql","python"],"latest_commit_sha":null,"homepage":"https://zoo-awwards.herokuapp.com/","language":"Python","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-22T11:37:10.000Z","updated_at":"2021-10-26T22:48:40.000Z","dependencies_parsed_at":"2023-06-02T04:15:32.592Z","dependency_job_id":null,"html_url":"https://github.com/KenMwaura1/zoo-awwards","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-awwards","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2Fzoo-awwards/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2Fzoo-awwards/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KenMwaura1%2Fzoo-awwards/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KenMwaura1","download_url":"https://codeload.github.com/KenMwaura1/zoo-awwards/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246738782,"owners_count":20825838,"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":["django","django-rest-framework","mdbootstrap","postgresql","python"],"created_at":"2024-12-14T17:15:17.927Z","updated_at":"2026-05-10T19:21:42.546Z","avatar_url":"https://github.com/KenMwaura1.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# zoo-awwards\nA Django application like Awwards (It doesn't necessarily have to be exactly the same). The application will allow a user to post a project he/she has created and get it reviewed by his/her peers.\n\n[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)\n\n![logo](static/images/Zoo-Awwards.gif)\n\nThe application will allow a user to post a project he/she has created and get it reviewed by his/her peers.\n\nA project can be rated based on 3 different criteria\n\n* Design\n* Usability\n* Content\n* These criteria can be reviewed on a scale of 1-10 and the average score is taken.\n\n1. User stories\nAs a user, I would like to:\n\n* View posted projects and their details\n* Post a project to be rated/reviewed\n* Rate/ review other users' projects\n* Search for projects\n* View projects overall score\n* View my profile page\n\n2. API Endpoints\nYou should create an API so that users can access data from your application. You can create two API endpoints:\n\n* Profile - This endpoint should return all the user profiles with information such as the username, bio, projects of the user and profile picture\n* Projects- This endpoint should return information pertaining to all the projects posted in your application.\n\n\n## Live Site\n\n[link to deployed site](https://zoo-awwards.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* PostgreSQL installed on your machine \n\n### Installation and Running the App\n\n1. Clone GitHub repository\n\n    ```shell\n    git clone https://github.com/KenMwaura1/zoo-awwards\n    ```\n\n2. Change into the folder\n\n    ```shell\n   cd zoo-awwards\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_awwards\n   ```\n\n  3b. Activate the virtualenv\n\n   ```\n   pyenv activate zoo_awwards\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 17**  and **line 43** in **z_awwards/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## API endpoints \n* https://zoo-awwards.herokuapp.com/api/users/ \n* https://zoo-awwards.herokuapp.com/api/profiles/\n* https://zoo-awwards.herokuapp.com/api/projects/\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-awwards","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkenmwaura1%2Fzoo-awwards","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkenmwaura1%2Fzoo-awwards/lists"}