Recipe Box Organizer

A recipe box database, 13.Jan.2021

By Jeff Chiu & Carmen Agata Kolodziej

Description:

Preview:

User Stories:

ID	User Story	Accepted
US001	As a user, I want to add a recipe with ingredients and instructions, so I remember how to prepare my favorite dishes.	true
US002	As a user, I want to tag my recipes with different categories, so recipes are easier to find. A recipe can have many tags and a tag can have many recipes.	true
US003	As a user, I want to be able to update and delete tags, so I can have flexibility with how I categorize recipes.	true
US004	As a user, I want to edit my recipes, so I can make improvements or corrections to my recipes.	true
US005	As a user, I want to be able to delete recipes I don't like or use, so I don't have to see them as choices.	true
US006	As a user, I want to rate my recipes, so I know which ones are the best.	true
US007	As a user, I want to list my recipes by highest rated so I can see which ones I like the best.	true
US008	As a user, I want to see all recipes that use a certain ingredient, so I can more easily find recipes for the ingredients I have.	true

Software Requirements

1. Internet browser of choice, Chrome recommended.
2. A code editor such as VSCode or Atom.
3. Install .NET core: MacOS & PC.
4. Install MySQL: MacOS & PC.
5. Install MySQL Workbench: Find appropriate version here.

Open Locally

1. Click on the link to my repository on github here.
2. Click on the green "Code" link near the top and above the README.md.
3. Alternatively open your terminal and use the command git clone https://github.com/jeffchiudev/PROJECTNAME into the directory you would like to clone the repository.
4. Open in text editor to view code.

Installing .NET

1. Download .NET Core SDK (Software Development Kit). Clicking this link will prompt a file download for your particular OS from Microsoft.
2. Open the file. Follow the installation steps.
3. Confirm the installation is successful by opening your terminal and running the command dotnet --version. The response should be something similar to this:2.2.105. This means it was successfully installed.

Import Database & Entity Framework Core

1. Navigate to the PROJECTNAME.Solution/PROJECTNAME directory in terminal.
2. Run command dotnet ef database update to generate database.
3. Run command dotnet ef migrations add [MIGRATIONNAME] and dotnet ef database update if you're making changes to the database.
4. To access your database that you've set up in MySQL workbench add the following code into a appsettings.json file in the PROJECTNAME.Solutions/PROJECTDIRECTORY:

{
    "ConnectionStrings": {
        "DefaultConnection": "Server=localhost;Port=3306;database=Jeff_Chiu_PROJECTNAME;uid=root;pwd=YourPassword;"
    }
}

5. Change server, port and UID as necessary.

Import Database with MySQL Workbench

1. Open MySQL and enter password.
2. Go to nav bar and click on Server and then Data Import.
3. Use the option Import from Self-Contained File.
4. Set Default Target Schema or create a new.
5. Select all schema objects you wnat to import and the option Dump Structure and Data is selected.
6. Click Start Import.
7. Optionally, using your SQL management program, paste the following schema statement to reproduce the database:

INSERT DATABASE SCHEMA HERE

View In Browser

1. To view in browser, navigate to PROJECTNAME.Solutions/PROJECTNAME in the command line.
2. Use command dotnet build and dotnet run to start a local version of the page.
3. Navigate to http://localhost:5000

Known Bugs

Support and Contact Details

If any errors or bugs occur please email me here.

Technologies Used

• .NET Core 2.2
• ASP.NET Core MVC
• Bootstrap
• C# 7.3
• CSS
• Entity
• Razor
• REPL
• VS Code

License

This software is licensed under the MIT License.

Copyright (c) 2021 Jeff Chiu & Carmen Agata Kolodziej