Visit the live Website : Family Recipes ➡️
- Family Recipes that are to be shared amoung family and friends.
- Users will be able to comment on and add useful suggestions of ways that the recipe can be improved.
User Stories:
- First time Visitor Goals
As a first time user of this site, I would like to be able to easily create a draft of a recipe.
- As a first time user, I would like to be able to comment on recipes.
- As a first time user, I would like to Like/Unlike the recipes.
- As a first time user, I would like to be able to view likes.
- As a first time user, I would like to view comments on the recipes.
- As a first time user, I would like to easily register.
- As a first time user, I would like to view a paginated list of recipes so that I can select which post I want to view.
- As a first time user, I would like to be able to edit and delete my comments.
- Python
- Django
- HTML
- CSS
- JavaScript
- Postgres
- Git: used to utilize the Gitpod terminal to commit to Git and Push to GitHub
- GitHub: used to store project code after being pushed from Git
- GitPod: used as cloud based IDE for writing code
- Balsamiq Wireframes: used to draw wireframes of pages of project
- Am I Responsive? used to give a visual of what the project looks like on various devices
- Heroku: used to deploy the Our Family Recipes app
- Cloudinary: used to import my Cloudinary field for the featured image
- Diffchecker: used to compare code when I had an error
To view all wireframes, go to WIREFRAMES.md
The live deployed application can be found at family-recipes14.herokuapp.com.
This project uses Heroku, a platform as a service (PaaS) that enables developers to build, run, and operate applications entirely in the cloud.
Deployment steps are as follows, after account setup:
- Select New in the top-right corner of your Heroku Dashboard, and select Create new app from the dropdown menu.
- Your app name must be unique, and then choose a region closest to you (EU or USA), and finally, select Create App.
- From the new app Settings, click Reveal Config Vars, and set the following key/value pairs:
CLOUDINARY_URL
(insert your own Cloudinary API key here)DATABASE_URL
(this comes from the Resources tab, you can get your own Postgres Database using the Free Hobby Tier)SECRET_KEY
(this can be any random secret key)
Heroku needs two additional files in order to deploy properly.
- requirements.txt
- Procfile
You can install this project's requirements (where applicable) using: pip3 install -r requirements.txt
. If you have your own packages that have been installed, then the requirements file needs updated using: pip3 freeze --local > requirements.txt
The Procfile can be created with the following command: echo web: gunicorn family_recipes.wsgi > Procfile
For Heroku deployment, follow these steps to connect your GitHub repository to the newly created app:
Either:
- Select "Automatic Deployment" from the Heroku app.
Or:
- In the Terminal/CLI, connect to Heroku using this command:
heroku login -i
- Set the remote for Heroku:
heroku git:remote -a <app_name>
(replace app_name with your app, without the angle-brackets) - After performing the standard Git
add
,commit
, andpush
to GitHub, you can now type:git push heroku main
The frontend terminal should now be connected and deployed to Heroku.
Gitpod IDE was used to write the code for this project.
To make a local copy of this repository, you can clone the project by typing the follow into your IDE terminal:
git clone https://github.com/FamilyRecipes.git
You can install this project's requirements (where applicable) using: pip3 install -r requirements.txt
.
Alternatively, if using Gitpod, you can click below to create your own workspace using this repository.
- put drop down menu to have user choose minutes and hours for the cooking time and prep time
- put drop down menu to have user choose measurement type
- have measurements able to be converted from metric to US standard
- add ability to put fractions in recipes
- have the user be able to add recipes of their own
- Readme used sample readme from code institute as a model. Github
- All content written by the developer.
- My Mentor for his help and feedback.
- Tutor support at Code Institute
- Family for help with help and feedback on website as a user
To view all testing, go to TESTING.md