Code Monkey home page Code Monkey logo

c-sharp-database-basics-independent-project's Introduction

Employee-Client Relationship Tracker (C# Web Application)

A web-based application to organize employees and clients, where the user can input new hires and create clients under the emoloyees, hosted on GitHub. Last Updated 03.13.2020.

By Krista Rutz

Description

This application, utilizing an MVC framework, lets the user, in this case a hair salon, keep track of employees and their clients. Employees can be added dynamically in a form, and clients can be listed under each employee account. The app implements this with C#, .NET Core, and SQL.

This project uses SQL, Entity Framework, RESTful routing, the Razor View Engine, and MVC conventions. It was created for the Epicodus week 11 friday independent project, on week 4 of C# and .NET course: Database Basics.

The source code is hosted on GitHub.

Installation / Set-up

Download or clone the repository to run this program locally!

This program requires .NET Core SDK to run. Here is a free tutorial for installing .NET on Mac or Windows 10.

This program also makes use of SQL databases. We recommend using MySQL Workbench to build your databases. Here is a free tutorial for installing MySQL WorkBench and MySQL Community Server on Mac or Windows 10.

  • Download or clone this repo.
    • To Download ZIP:
      • Select "Download" on the GitHub Repository site
      • Once downloaded, open the ZIP and extract files. The new folder will be created as 'VendorList.Solution'.
    • To Clone:
      • Clone from command line into your Desktop: $ git clone https://github.com/KristaRutz/C-Sharp-Database-Basics-Independent-Project.git
      • The new directory will be created as 'Desktop/C-Sharp-Database-Basics-Independent-Project'.
  • Build your local databases.
    • To construct in the command line:
      • run your MySQL server from the command line.
      • use the commands listed in the 'DataBaseSetUpInstructions.txt' file in the root directory of this project.
    • To construct import from my file:
      • Open MySQL Workbench. In the Navigator > Administration window, select Data Import/Restore.
      • In Import Options select Import from Self-Contained File.
      • Navigate to the sql file at 'DumpStructure.sql' in the root directory of this project.
      • Under Default Schema to be Imported To, select the New button.
      • Enter the desired name of your database. The program is currently set to look for a database called 'krista_rutz'. If you use a different name, you will need to change the connection string in appsettings.json to reflect this.
      • Click Ok.
      • Click Start Import.
      • Reopen the Navigator > Schemas tab. Right click and select Refresh All to see the database appear.
  • Once you have stored the files locally and built databases, execute the following commands.
    • Navigate to the application directory: $ cd VendorList.Solution/VendorList
    • dotnet build
    • dotnet run
  • Upon success, the program will begin running on a local server.

Technologies Used

  • C#
  • .NET Core 2.2
  • MySQL Server and MySQL Workbench
  • Entity Framework
  • HTML with Razor
  • CSS: Custom and Bootstrap

Specifications

  • Database table and column names follow both the specific requirements for this project and general .NET naming conventions.
  • Instructions for re-creating your database are thorough and clear.
  • There is a one-to-many relationship set up correctly in the database.
  • CREATE functionality is included for one class and CREATE and VIEW functionality are included for the other class.
  • Entity is used for communication with the database
  • The project demonstrates understanding of this week's concepts.
  • The project is in a polished, portfolio-quality state.
  • Project uses two or more controllers.
  • GET and POST requests/responses are used successfully.
  • MVC routes follow RESTful conventions.
  • Logic is easy to understand.
  • Build files are included in .gitignore file and are not be tracked by Git
  • Code and Git documentation follows best practices (descriptive variables names, proper indentation and spacing, separation between front and back-end logic, detailed commit messages in the correct tense, and a well-formatted README).

User Stories

As a User-Type, I want... so that...
As the business owner I want employees that I add to be stored in a database so that I can access them as often as I need
As the business owner, I want to add new employees so that I can view the complete list
As the salon owner, I need to be able to select a stylist, see their details, and see a list of all clients that belong to that stylist to stay organized
As the business owner, I want to see the clients belonging to those employees to simplify payment accounts
As the salon owner, I need to be able to add new clients to a specific stylist (I should not be able to add a client if no stylists have been added) so that I don't have unassigned clients by mistake.
As the business owner, I want name and preferred employee for clients visible so that my tracker is useful from both sides
As the business owner, I want a splash page so that I can access any sides of my site
As the business owner, I want to be able to delete clients or employees in case of changes to the business
As the business owner, I want to be able to edit clients or employees in case of changes, or user error

Known Bugs

No known bugs

Support and contact details

Please contact me if you run into any issues or have questions, ideas or concerns. I can be contacted at [email protected]. Feel free to fork and create pull requests for updates - contributions to the code are encouraged!

License

Copyright (c) 2020 Krista Rutz

This software is licensed under the MIT license.

View license details

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.

c-sharp-database-basics-independent-project's People

Contributors

kristarutz avatar

Watchers

 avatar  avatar

Forkers

seschwartz8

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.