Pierre's Sweets and Savories

C#, Database, and Identity Authentication practice for Epicodus, 08.14.2020

By Jeff Kim

Description

Pierre's Business is booming and he needs the same pizazz that we applied to his bakery to help sell his new sweet and savory treats! He wants to be able to have a list of treats, as well as a list of flavors and to be able to associate them so that he can have multiple flavors for each treat and vice-versa. He also wants his employees to be able to log in so that they can add, update, delete, and associate treats and flavors, while customers will only be able to view what is available for the day.

This project uses C#, MySQL, Entity Framework, Microsoft Identity, and MVC to create a web interface that will allow the greatest video rental franchise of all time to maintain a daily menu of treats, categorize them by flavor, and allow authorized users to employ full CRUD functionality. The interface will achieve this by utilizing a MySQL database along with Identity authorization.

Specifications

Behavior Input Output Completed(Y/N?)
Create an object called Treat with an auto-implementing property for its Name Y
Create an object called Flavor with an auto-implementing property for its Name Y
Allow authorized users to create a new Treat object through a user interface Y
Allow authorized users to create a new Flavor object through a user interface Y
Create a database with tables for Treat and Flavor objects using Entity Framework and code first development and database migrations Y
Maintain a many-to-many relationship between Treat and Flavor objects via a joing table Y
Allow authorized users to create a new join relationship between an Treat and a Flavor from each object's details page Y
Allow unauthenticated users to view a list of Treats and Flavors, as well as their details page Y
Restrict unauthenticated users from Creating, Editing, Deleting, or Associating Treat or Flavor objects Y

Setup/Installation Requirements

Requirements:

To use this program:

  1. Open your preferred browser.

  2. Navigate to https://github.com/jkbutserious/PierreSweets.Solution.git.

  3. Click the Code button and click Download ZIP to clone the repository to your computer.

  4. Open the Windows PowerShell console, VS Code Bash terminal, or the MacOS Terminal and use the cd [YOUR DOWNLOAD FILEPATH]/PierreSweets.Solution/Blockbuster command to navigate to the Blockbuster subdirectory.

  5. Use the dotnet restore command to install the necessary packages on your computer.

  6. Use the dotnet run command to run the program.

  7. Use the web interface to add engineers and machines and keep track of Dr. Sneuss's Blockbuster.

  8. Ensure that the following code is present in your appsettings.json file:

    {
      "ConnectionStrings": {
          "DefaultConnection": "Server=localhost;Port=3306;database=jeff_kim;uid=root;pwd=epicodus;"
      }
    }
    
  9. If you have any issues running this program, please reach out to the developer or troubleshoot at your own risk.

To recreate the database using MySQL and Entity Framework Core:

Note: These instructions assume that you have installed and set up your MySQL Server according to Epicodus's guidelines, as well as Entity Framework Core. For more information, see Installing and Configuring MySQL and Configuration for Entity Framework Core.

  1. Open Windows PowerShell, the MacOS Terminal, or your VS Code terminal and use the command cd [YOUR DOWNLOAD FILEPATH]/PierreSweets.Solution.
  2. Ensure that the Migrations folder is included in your cloned repository.
  3. Use the dotnet ef database update command to apply the latest database migration.
  4. Use MySQL Workbench or your preferred terminal to verify the database schema.

To contribute to this project:

  1. Open your preferred browser.
  2. Navigate to https://github.com/jkbutserious/PierreSweets.Solution.
  3. Log into or sign up for your GitHub account.
  4. Click the Fork button to copy the repository and all source code.
  5. From your forked repository, you can download or clone the repository, by clicking the Code button.
  • To clone the repository in Visual Studio Code's terminal, use the command

    git clone https://github.com/[YOUR-USER-NAME-HERE]/PierreSweets.Solution

  • To clone the repository in GitHub Desktop, click the Open in Desktop option

  • To download the repository, click the Download ZIP option, save the archive to your computer, and extract it to the folder of your choice

  1. Use your preferred code editor to edit the appropriate model and view files. New classes should be added in the Models subdirectory and should use the Blockbuster.Models namespace. Note: the Blockbuster.csproj file is a C# project file and should not be edited.

  2. Use the dotnet ef migrations add [YOUR MIGRATION NAME HERE] to add a new database migration.

    You can also export your database schema from MySQL Workbench by using the Data Export option on the Administration tab of your database, select the schema you want to export, select the Dump Structure and Data option from the dropdown menu, and click the Start Export button. Make sure to name the file jeff_kim.sql and add the file to your repository in the top-level directory.

  3. Save any changes you make in your code editor and use your preferred git solution to commit your changes.

  4. Push your changes to your forked repository.

Additional Setup/Installation Notes:

  • No additional code is necessary to view this project.

Known Bugs

No known issues. Please contact me if you have any problems.

Support and contact details

To report any issues with this page or to contribute to this project, contact Jeff Kim at kim2jy@hotmail.com.

Technologies Used

  • C#
  • .NET Core 2.2
  • MySQL Server 8.0.19
  • MySQL Workbench 8.0.19
  • Entity Framework
  • ASP.NET Core Identity
  • MVC
  • Visual Studio Code
  • Git and Git BASH

License

Copyright © 2020 Jeffrey Kim

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.