Skip to content

Commit

Permalink
updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
TimPin28 committed Jul 3, 2022
1 parent 5ea822b commit 72fcbeb
Show file tree
Hide file tree
Showing 10 changed files with 39 additions and 1 deletion.
40 changes: 39 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

cookit is a recipe-sharing site where anyone can share their dishes no matter what cuisine!

You can either download the code, or open it using this link: [https://cookit-apdev.herokuapp.com](https://cookit-apdev.herokuapp.com)
You can either run the project locally, or open it using this link: [https://cookit-apdev.herokuapp.com](https://cookit-apdev.herokuapp.com)


## Features
Expand Down Expand Up @@ -42,3 +42,41 @@ You can either download the code, or open it using this link: [https://cookit-ap

#### Note
The application will initially be without any entries since your database is not yet populated.

## How to Use cookit
First, create an account by clicking on "Register" on the top-right of the page.

### Creating a cookit account
Enter a username, email, and password. Make sure that the passwords in both fields are the same, and are at least 6 characters in length.<br />
![alt text](screens/registerpage.PNG "Register page")

If your account was successfully created, you will be redirected to the login page. Login with the username and password you entered earlier.<br />
![alt text](screens/loginpage.PNG "Login page")

### The home page
Here, you'll see all the recipes currently posted on the site. You can use the search bar in the header to look for recipes based on their name or tags.<br />
![alt text](screens/homeposts.PNG "Home page")

By default, all posts are sorted by how recently they were added. If you want to sort by alphabetical order, hover over sort and click on "Alphabetical".<br />
![alt text](screens/sort.PNG "Sort")

### Creating a recipe post
Enter a title for your recipe post, some tags (i.e. what cuisine it is, what kind of ingredients are in it, etc.), the ingredients, instructions, and an image of your dish. Press "Create" at the bottom to create the recipe post!<br />
![alt text](screens/samplecreate.PNG "Create page")

You'll be redirected to your newly created recipe post! You can edit or delete it using the buttons under the recipe title. Note that you have to be logged in to do these actions. If you want to edit your post, it'll be the same interface as creating one.<br />
![alt text](screens/viewpost.PNG "View page")

You and other cookit users may comment on any post on the site. You may also edit and delete your own comments.<br />
![alt text](screens/comment.PNG "View Comment")

### Viewing user profiles
If you want to view your own profile, make sure you are logged in and click on the button with your username at the top-right of the page. Here, you'll see your profile picture, username, the date you joined on, and your submitted posts.<br />
![alt text](screens/profile.PNG "Profile page")

To view other cookit users' profiles, just click on their usernames when you view their recipe posts.

### User settings
If you want to change your password, your profile picture, or delete your account all together, these options are available when you click on the "Settings" button in the header. <br />
If you decide to delete your account, all your comments and posts will automatically be deleted as well.<br />
![alt text](screens/settings.PNG "Settings page")
Binary file added screens/comment.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screens/homeposts.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screens/loginpage.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screens/profile.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screens/registerpage.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screens/samplecreate.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screens/settings.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screens/sort.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screens/viewpost.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 72fcbeb

Please sign in to comment.