generated from Code-Institute-Org/gitpod-full-template
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reinstated TOC in README- human error
- Loading branch information
1 parent
bba7f23
commit ee5acca
Showing
1 changed file
with
37 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,8 +2,6 @@ | |
<a href="https://bake-it-til-you-make-it.herokuapp.com/" target="_blank"><img src="https://i.ibb.co/k99xn4b/bakeit-banner.png" alt="Bake It 'Til You Make It"></a> | ||
</h1> | ||
|
||
# Bake It Til You Make It | ||
|
||
<div align="center"> | ||
<p>A community-based web application for those who love the art of baking, where users can search and share their favourite creations.</p> | ||
|
||
|
@@ -15,6 +13,35 @@ | |
<hr> | ||
</div> | ||
|
||
### Table of contents | ||
1. [UX](#UX) | ||
1. [Project Goals](#Project-Goals) | ||
2. [User Stories](#User-Stories) | ||
3. [Development Planes](#Development-Planes) | ||
2. [Data Schema](#Data-Schema) | ||
1. [Users Collection](#Users-Collection) | ||
2. [Recipes Collection](#Recipes-Collection) | ||
3. [Categories Collection](#Categories Collection) | ||
3. [Features](#Features) | ||
1. [Design Features](#Design-Features) | ||
2. [Existing Features](#Existing-Features) | ||
3. [Features to Implement in the future](#Features-to-Implement-in-the-future) | ||
4. [Issues and Bugs](#Issues-and-Bugs) | ||
5. [Technologies Used](#Technologies-Used) | ||
1. [Languages](#Languages) | ||
2. [Tools](#Tools) | ||
3. [Libraries](#Libraries) | ||
4. [Database Management](#Database-Management) | ||
6. [Testing](#Testing) ☞ **[Testing.md](TESTING.md)** | ||
7. [Deployment](#Deployment) | ||
1. [1. Database Creation](#1-Database-Creation) | ||
2. [2. Local Copy Creation](#2-Local-Copy-Creation) | ||
3. [3. Heroku App Creation](#3-Heroku-App-Creation) | ||
8. [Credits](#Credits) | ||
9. [Acknowledgements](#Acknowledgements) | ||
10. [Technical Support](#Technical-Support) | ||
*** | ||
|
||
 | ||
|
||
*** | ||
|
@@ -319,7 +346,7 @@ While the developer relied heavily on these Wireframes in order to maintain the | |
- The [Paper 2](https://www.transparenttextures.com/paper-2.html "Link to Paper 2 Texture") texture was used as the background for the 'notebook' effect. | ||
- The [Lined Paper](https://www.transparenttextures.com/lined-paper.html "Link to Lined Paper Texture") texture was used as the background for the card and image panels. | ||
|
||
[Back to top ⇧](#bake-it-til-you-make-it) | ||
[Back to top ⇧](#table-of-contents) | ||
|
||
## Data Schema | ||
|
||
|
@@ -545,7 +572,7 @@ The **Call to Action** buttons on the recipe page are conditional to the user's | |
- A feature that would allow for the developer to send an automated email to users on registration, verifying their email and account. | ||
- This, too, was in the original plans and the developer tried their best to be able to implement it in this release, but it was not meant to be. | ||
[Back to top ⇧](#bake-it-til-you-make-it) | ||
[Back to top ⇧](#table-of-contents) | ||
## Issues and Bugs | ||
The developer ran into a number of issues during the development of the website, with the noteworthy ones listed below, along with solutions or ideas to implement in the future. | ||
|
@@ -584,7 +611,7 @@ In order to avoid this error, the developer installed and selected `Flake8` to l | |
**Reverted Commits Note** <br> | ||
The developer was forced to revert two commits ([1](https://github.com/rebeccatraceyt/bake-it-til-you-make-it/commit/4a410cb11de6f90f3fb4a698e61818b1724e7cd6) and [2](https://github.com/rebeccatraceyt/bake-it-til-you-make-it/commit/7a1f64dd73470a54868ffbea1eeb8c6a54770d47)) on the 8th of June in order to backtrack to a previous commit, preserving the functionality that was lost. After trying to implement a `partials` directory, that would store extendable blocks to be used on all pages, the developer noticed that, in doing so, vital functions, including **user authentication** were throwing an error. Having already pushed these commits to Github, the developer reverted the commit that implemented the creation of the `@login_decorator` in `app.py`, as they believed this to be the cause. Once this was reverted, it was clear that it was not the cause, the commit previous to that (the implementation of the `partials` directory) was reverted as well. In doing this, the functionality was restored. The developer chose not to re-implement the `partials` directory but was successful in re-implementing the `@login_decorator` functionality at a later date. | ||
[Back to top ⇧](#bake-it-til-you-make-it) | ||
[Back to top ⇧](#table-of-contents) | ||
## Technologies Used | ||
### Languages | ||
|
@@ -652,7 +679,7 @@ The developer was forced to revert two commits ([1](https://github.com/rebeccatr | |
- MongoDB Atlas was the cloud database service used to host the database. | ||
[Back to top ⇧](#bake-it-til-you-make-it) | ||
[Back to top ⇧](#table-of-contents) | ||
## Testing | ||
|
@@ -795,7 +822,7 @@ Heroku will receive the pushed code from the GitHub repository and host the appl | |
The deployed version can now be viewed by selecting `View App` in the top-right of the page. | ||
[Back to top ⇧](#bake-it-til-you-make-it) | ||
[Back to top ⇧](#table-of-contents) | ||
## Credits | ||
The developer consulted multiple sites in order to better understand the code they were trying to implement. | ||
|
@@ -808,7 +835,7 @@ For code that was copied and edited, the developer made sure to reference this w | |
- [Bootstrap](https://getbootstrap.com/ "Link to BootStrap page") | ||
- [JSfiddle](https://jsfiddle.net/ "Link to JSfiddle page") | ||
[Back to top ⇧](#bake-it-til-you-make-it) | ||
[Back to top ⇧](#table-of-contents) | ||
## Acknowledgements | ||
The developer would like to thank the following: | ||
|
@@ -817,14 +844,14 @@ The developer would like to thank the following: | |
- Their mentor Seun, for her consistent guidance and support. | ||
- Their family and friends, for providing a limitless amount of encouragement and suggestions during the entire process of development. | ||
[Back to top ⇧](#bake-it-til-you-make-it) | ||
[Back to top ⇧](#table-of-contents) | ||
*** | ||
## Technical Support | ||
If you encounter any issues with this website, or require any further clarification or support, please email the [developer](mailto:[email protected]?subject=[Bake%It%Support]). Thank you! | ||
[Back to top ⇧](#bake-it-til-you-make-it) | ||
[Back to top ⇧](#table-of-contents) | ||
*** |