metricsapp API

By Brandon Wright

This repo contains only the C#/.Net back-end API of a single page application for collecting, storing, and visualizing user-support interactions for various portals. Full functionality requires that you also clone the React front-end from https://github.com/brandonfullstack/metrics-app

Technologies Used

• C#
• .NET.
• Entity Framework Core
• MySQL
• Git

Setup/Installation Requirements

Note: An installation of the .NET SDK is required in order to run this application locally. See Here for installation.

Please install Entity Framework Core by running the following command in your terminal:

$ dotnet tool install --global dotnet-ef --version 6.0.0

Additionally, please install the following for versioning functionality:

$ dotnet add package Microsoft.AspNetCore.Mvc.Versioning $ dotnet add package Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer

1. Copy project directory or clone repo from Github (https://github.com/brandonfullstack/MetricsApi.Solution) to your desktop.
2. Open your terminal (e.g., Terminal or GitBash) and navigate to this project's production directory called "MetricsApi".
3. Create a file named appsettings.json: $ touch appsettings.json
4. Within appsettings.json add the following code, replacing the uid and pwd values with your own username and password for MySQL. Replace the database value with the name that you wish to give the database that will back up this application. Entity will create the database for you in a subsequent step.

{
  "Logging": {
    "LogLevel": {
    "Default": "Information",
    "Microsoft.AspNetCore": "Warning"
    }
  },
    "AllowedHosts": "*",
    "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Port=3306;database=metrics_api;uid=root;pwd=epicodus;"
  }
}

5. Within appsettings.Development.json add the following code:

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Trace",
      "Microsoft.AspNetCore": "Information",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  }
}

6. Run $ dotnet ef database update. This command will create the database and required tables on your local machine.
7. Navigate to the project directory: $ cd MetricsApi
8. In the command line, run the command $ dotnet run to compile and execute the web API.
9. Open your browser and navigate to http://localhost:5000/swagger if it doesn't open for you automatically.

Known Bugs

• No known issues
• Please visit this projects GitHub repository to submit Issues and Pull Requests.

License

MIT

Copyright (c) 2023 Brandon Wright