Marked Down

An e-commerce website...

By Chloe Loveall, Louie Schoenknecht & Scott O'Neil

         

Table of Contents

1. Table of Contents
2. Description
3. Preview
4. Technologies Used
5. Setup and Installation Requirements
   • Prior to Installation
     • Git Installation
     • .NET Installation
   • Installation
   • Database Setup
     • MySQL Password Protection
     • Entity Framework Core Database Setup
   • Launching the Program
6. User Stories
7. Specifications
8. Known Bugs
9. Issues
10. Roadmap
11. Design
12. Contributing
13. License
14. Acknowledgements
15. Contact Information

Preview

Live preview with Heroku

Technologies Used

• ASP.NET 5.0.1
• C#
• Entity Framework 5.0.0
• MySQL 8.0.15
• MySQL Workbench 8.0.15
• Razor

Setup and Installation Requirements

Prior to Installation

Confirm you have Git installed

• Installing Git on Macs:

  • Install the package manager Homebrew by copying and pasting the following in the terminal: $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  • Copy and paste once of the following lines in the terminal so that Homebrew packages are run before the system versions of the same packages:
    • For bash users: $ echo 'export PATH=/usr/local/bin:$PATH' >> ~/.bash_profile
    • For zsh users: $ echo 'export PATH=/usr/local/bin:$PATH' >> ~/.zshrc
  • Last, install Git with the following terminal command: $ brew install git

• Installing Git on Windows:

  • Open Command Prompt, the Windows terminal program. You can access it by typing Cmd in the search bar in the bottom left corner.
  • NOTE There are many options available, but we recommend using a free program called Git Bash
  • Navigate to Git Bash and click on the Download button. This will take you to a page with the latest version of Git Bash. Determine whether you have 32-bit or 64-bit Windows by following these instructions. Then download the corresponding exe file from the Git for Windows site. (If you have a package manager already installed, you can also choose to download the tar.bz2 version.)
  • Click on the downloaded file and then follow the instructions in the Setup menu until you reach the Install button and install the package.

Confirm you have .NET installed

Installing .NET will provide provide access to the C# language

• .NET for macOS
• .NET for Windows
• Additionally, you may want to install a REPL to allow you to practice, test, and experiment with C#. Below are instructions for the dotnet script REPL:
  • Install dotnet script by running the following terminal command: $ dotnet tool install -g dotnet-script
  • NOTE: If you just installed .NET 5, restart the terminal. (Otherwise, you will not be able to run the following command.)
    • Enter $ dotnet script in your terminal and a prompt will open: >
    • To exit the REPL press: Ctrl +C

Installation

• Clone the repository with the following git terminal command: $ git clone https://github.com/chloeloveall/Factory.Solution.git
• Open the project directory in your terminal
• Navigate to the Factory directory (the production directory)
  • To create an obj directory and install dependencies, run the terminal command: $ dotnet restore
  • NOTE: Do not touch the code in the obj directory.

Database Setup

MySQL Password Protection

• Create a the following file: appsettings.json

• Add the following code:

  

• NOTE: [YOUR_DATABASE] must match the database name you chose to import above

• NOTE: [YOUR_PASSWORD] must match your local MySQL server password

• NOTE: The appsettings.json file is included in the .gitignore file

  • You can read more about best practices for storing private information with ASP.NET Core here

Entity Framework Core Database Import

• Confirm you have MySQL installed
• Confirm you have MySQL Workbench installed
• From the production directory (Factory.Solution/Factory), run the following terminal command: dotnet ef migrations add Initial
• Then, also from the production directory, run this command: dotnet ef database update
• Open MySQL Workbench and verify that there is a new database with the database name you specified in the appsettings.json file

MySQL Workbench Database Import

• Open MySQL Workbench and select Local Instance 3306
• In the Administration tab, select Data Import/Restore

• Select Import from Self-Contained File
• Select the file chloe_loveall.sql from the Factory.Solutions root directory
• Select New from the Default Schema to be Imported To section

• Choose a name for the database and select Ok
• Select Start Import

Launching the program

• You are now ready to run the program! To launch the program, navigate to the production directory (Factory.Solution/Factory) and run the following terminal command: dotnet run
  • NOTE: You can alternately use dotnet watch run if you would like to make and view changes without needing to relaunch dotnet run
• In the browser of your choice, navigate to: http://localhost:5000/

User Stories

Specifications

Behavior	Input	Output

Known Bugs

• None at this time

Issues

• Report issues here and select the New issue button for support and

Roadmap

Design

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the project on GirHub
   • Follow Installation and Setup Requirements above
2. Create your Feature Branch: $ git checkout -b YourFeatureBranchName
3. Commit your Changes $ git commit -m 'Add some Amazing Feature'
4. Push to your feature branch on Github $ git push origin YourFeatureBranchName
5. Open a Pull Request

License

MIT

Acknowledgements

• Absurd Design
• Canva
• Choose an open source license
• Codepen.io/ClaireLarsen
• Coolors
• Microsoft C# Documentation
• Pexels: Royalty Free Images
• Shields
• Unplash: Photos for Everyone
• StartUp Ipsum
• Best-README-Template
• dbader README-Template

Contact Information

Chloe Loveall chloeloveall@protonmail.com Louie Schoenknecht luisesch97@gmail.com Scott O'Neil scottieoneil@gmail.com

   

Back to Top