Parks Lookup

Description of application, July-02-2021

By Saoud Rana

Independent project to practice with C#, building an API, CRUD, and SwaggerUI.

Setup/Installation Requirements

Go to ParksLookup.Solution Folder and create a file called appsettings.json file and input the following script (note the name of the database below needs to match the name of the database you created) Also change [ENTERPASSWORDHERE] to the password you set prior.

  "ConnectionStrings": {
      "DefaultConnection": "Server=localhost;Port=3306;database=saoud_rana;uid=root;pwd=[ENTERPASSWORDHERE];"
  }
}

Software Requirements

Internet browser
A code editor such as VSCode to view and edit the code
.NET or follow along with the Installing .NET instructions to install .NET

Open Locally

Click on the link to my repository: My Repository
Click on the green "Code" button and copy the repository URL
Open your terminal and use the command git clone https://github.com/saoud/ParksLookup.Solution.git into the directory you would like to clone the repository
Open in text editor to view code and make changes

Installing .NET

In order to run the application, please install .NET for your computer to recognize the dotnet command.

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

Installing MySQL

MySQL is a type of database software used to create, edit, query, and manage SQL data.

For Mac Users please Click Here to download MySQL Installer
For Windows Users please Click Here
Verify MySQL installation by opening the terminal and entering the command mysql -u[USERNAME] -p[THEPASSWORDYOUSELECTED]
If you gain access you will see see the MYSQL command line!

Installing MySQL Workbench

Please Click Here to install the correct version for your machine
Open MySQL Workbench and select Local instance 3306 server. You will need to enter the password you selected

Compiling

Navigate to the ParksLookup folder in the command line
Use the command dotnet build to compile

Installing Packages

Navigate to the Factory folder in the command line
Use the command dotnet restore

### Update Database Using MySQL Workbench

Open MySQL Workbench
Click on Server > Data Import in the top navigation bar
Select Import from Self-Contained File
Select the Default Target Schema or create new schema
Select all Schema Objects you would like to import
Select Dump Structure and Data
Click Start Import

Expand for Database Installation Essentials!

Import Database Using Entity Framework Core

Navigate to Factory directory in terminal
Use the command dotnet ef database update to generate the database through Entity Framework Core

Update Database Using Entity Framework Core

Write any new code you wish to add to the database. Use the command dotnet build to check for any compiling errors. If no errors, proceed to step 2.
To update the database with any changes made to the code, use the command dotnet ef migrations add [MigrationsName]
Use the command dotnet ef database update to update the database

View In Browser

To view in browser, navigate to Factory folder in the command line
Use the command dotnet run to execute the compiled code and start a localhost
In browser navigate to http://localhost:5000/swagger
Or Navigate to https://localhost:5001/swagger for the SSL version.

Known Bugs

None known

Support and Contact Details

If any errors or bugs occur with installation, delete both bin and obj folders and follow the Compiling and Installing Packages instructions again. Get help or report a bug you have found in the .NET platform at .NET Support. Or please email me, [email protected].

Technologies Used

- _ASP.NET Core 5.0_
- _C#_
- _dotnet script, REPL_
- _Git and GitHub_
- _Microsoft Entity Framework Core_
- _MySQL and MySQL Workbench_
- _Postman_
- _RESTful Routing and CRUD_
- _Swagger and SwaggerUI_
- _Swashbuckle_
- _Visual Studio Code_

saoud / parkslookup.solution Goto Github PK

parkslookup.solution's Introduction