Gram Clone
Description:
Instagram clone using Django framework is a simple page where users could interact with their photos, and other users'. They can sign up, and login to their account, post pictures, post comments on other user's pictures, as well as follow other users.
Author:Atieno Obwanda
Gram Clone for your eyes!
Live link: https://.herokuapp.com/
User Story
- As a user, you can sign up, then login to your account
- You can also post images and start liking and commenting on other images
- You can also follow other users, who have registered themselves with Gram Clone
- One can also search for other users, by username and the search results returns the total number of users found for that search!
BDD
| Behaviour | Input | Output |
|---|---|---|
| Load the page | On page load | From home page, sign up for an account or navigate to the login page if you already have ann acccount |
| After successfully signing, up, you'll be redirected to the login page where you'll be required to key in your credentials | After logging in, you will be redirected to the feed page, where you can see images from other users | |
| You can like, and comment on other users images should you be interested | You can search by for users using usernames | Search results displays the number of returned results for that particular search |
| For returning users, you can Login username and password | Then you are redirected to the feeds page with posts. Also, you can comment on all posts... If you're post author, you can edit the post by clicking on 3 dot on the post-card on your post! | |
| As a logged in user, you can be able to update your account by selecting edit profile | The EDIT PROFILE button redirects you to a page where you can edit your profile details including display image |
Setup/Installation Requirements
From your terminal:
git clone git@github.com:AtienoObwanda/gramClone.gitOnce the program has been cloned, run this on your terminal
cd gramClone
Depending on your code editor,run this on your terminal:
Vs Code
code .
Atom
atom .
In order to run this project your can git clone it and then download all the requirements started on the requiremen.txt, open the app in the editor of your choice,open your terminal and run the app
To contribute:
- Fork the repository
- Create a new branch (git checkout -b improve-feature)
- Make the appropriate changes in the files
- Add changes made
- Commit your changes (git commit -am 'Improve feature')
- Push to the branch (git push origin improve-feature)
- Create a Pull Request
Technologies Used
Python3.9.12
Django 4
Bootstrap 5
Bugs
There are no known bugs...
Contact:
Incase of any question or contributions, you can contact me through:
Atieno Obwanda ||atienoobwanda@gmail.com
License
MIT License
Copyright (c)2022 GRAM CLONE All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.