TravelAPI

In-class Project for Epicodus in ASP.NET CLI Core & Building an API

Project Began on 1.19.2021. Last updated 1.21.2021.

---

Table of Contents generated with DocToc

• 📖 Description
• User Stories
• 🐛 Known bugs
• Stretch Goals
• 🛠️ Technologies Used/Required
• 🔧 Installation Requirements
  • Installing Git
    • For Mac Users
    • For Windows Users
  • Installing C#, .NET, dotnet script, & MySQL
    • For Mac
    • For Windows (10+)
  • For Mac & Windows Operating Systems
  • Clone or Download the Project
    • To Clone
    • To Download
    • .NET Core Commands
  • Setting up a Local Database
  • MySQL Password Protection & .gitignore
  • Import Database in MySQL Workbench
  • Import Database with Entity Framework Core
  • API Documentation
  • Accessing the SwaggerUI
    • API Setup References
• 📫 Contact
• License

---

📖 Description

Dotnet API and MVC project, meant to get and post travel reviews of various destinations a user has visited around the world.

User Stories

User Stories
1	As a user, I want to GET and POST reviews about travel destinations.
2	As a user, I want to GET reviews by country or city.
3	As a user, I want to see the most popular travel destinations by number of reviews or by overall rating.
4	As a user, I want to PUT and DELETE reviews, but only if I wrote them. (Start by requiring a user_name param to match the user_name of the author on the message. You can always try authentication later.)
5	As a user, I want to look up random destinations just for fun.

🐛 Known bugs

• Home splash page is not fully set up, nor are all our client-side views fully set up or created - although all CRUD routes are in place.

Please report any bugs found here.

---

Stretch Goals

• Build out UI more.
• Use SwaggerUI & SwaggerHub more extensively.

🛠️ Technologies Used/Required

• Postman v.7.22.1
• Swashbuckle, v. 5.6.2, for OpenAPI implementations for .NET with Swagger.
• SwaggerUI, v. 5.6.3
• Swagger, For API Documentation, v. 3.0.1
• C# v 7.3
• .NET Core CLI v 2.2
• Identity, ASP.NET MVC Core
• MySQL, MySQL Workbench 8.0
• Entity Framework Core 2.2.6, CRUD, RESTful routing
• dotnet script, REPL
• Razor
• SQL Design Planner
• Visual Code Studio

---

🔧 Installation Requirements

Installing Git

For Mac Users

• Access Terminal in your Finder, and open a new window. Install the package manager, (Homebrew) [https://brew.sh/], on your device by entering this line of code in Terminal: $ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)".
• Ensure Homebrew packages are run with this line of code: echo 'export PATH=/usr/local/bin:$PATH' >> ~/.bash_profile.
• Once homebrew is installed, install Git, a version control system for code writers, with this line of code brew install git.

For Windows Users

• Open a new Command Prompt window by typing "Cmd" in your computer's search bar.
• Determine whether you have 32-bit or 64-bit Windows by following these (instructions)[https://support.microsoft.com/en-us/help/13443/windows-which-version-am-i-running].
• Go to (Git Bash)[https://gitforwindows.org/], click on the "Download" button, and download the corresponding exe file from the Git for Windows site.
• Follow the instructions in the set up menu.

Installing C#, .NET, dotnet script, & MySQL

• Install C# and .Net according to your operating system below.

For Mac

• Download this .NET Core SDK (Software Development Kit)[https://dotnet.microsoft.com/download/thank-you/dotnet-sdk-2.2.106-macos-x64-installer]. Clicking this link will prompt a .pkg file download from Microsoft.
• Open the .pkg file. This will launch an installer which will walk you through installation steps. Use the default settings the installer suggests.
• Confirm the installation is successful by opening your terminal and running the command $ dotnet --version, which should return something like: 2.2.105.

For Windows (10+)

• Download either the 64-bit .NET Core SDK (Software Development Kit)[https://dotnet.microsoft.com/download/thank-you/dotnet-sdk-2.2.203-windows-x64-installer]. Clicking these links will prompt an .exe file download from Microsoft.
• Open the file and follow the steps provided by the installer for your OS.
• Confirm the installation is successful by opening a new Windows PowerShell window and running the command dotnet --version. You should see something a response like this: 2.2.105.

For Mac & Windows Operating Systems

• Install dotnet script with the following terminal command dotnet tool install -g dotnet-script.

Clone or Download the Project

To Clone

1. Once you have Git installed on your computer, go to this GitHub repository.
2. Click the Green 'Code' button.
3. Copy the HTTPS link, and open a Terminal or CMD on your local system.
4. In the Terminal/CMD, navigate to your Desktop with the command cd Desktop.
5. Clone this application onto your local Terminal or CMD with the following command:git clone https://github.com/dani-t-codes/TravelAPI.Solution.git.
6. Navigate to the project from your Terminal/Cmd with the command cd TravelAPI.Solution.

To Download

1. Alternatively, click the Green 'Code' button from the GitHub repository listed above.
2. Select the "Download Zip" from the dropdown options.
3. Open/unzip the file that has been downloaded to your local system.
4. Open VSCode, or another code editor of your choice, and navigate to the unzipped file folder from File>Open...>TravelAPI.Solution to view the project.

.NET Core Commands

When the project is opened on your local machine...

• dotnet restore to install packages listed in project's boilerplate.
• dotnet build will get bin/ and obj/ folders downloaded.
• dotnet run will run the application.

(Ensure you are in the project's root directory, TravelAPI, in your Terminal/CMD before running these commands.)

Setting up a Local Database

• Download MySQL Server.
• (Note: If you need additional assistance setting up MySQL, visit their site for further instructions.
• Download MySQL Workbench.
• Run dotnet ef migrations add Initial --> If there is an error stating "Unable to resolve project", this means the command wasn't run in the correct directory.
• Entity creates three files in the Migrations directory.
• Run the following command: dotnet ef database update.

MySQL Password Protection & .gitignore

1. Create a file in the root directory of the project called "appsettings.json". Add the following snippet of code to the appsettings.json file:

{
  "ConnectionStrings": {
    "DefaultConnection": "Server=localhost;Port=3306;database=danielle_thompson_bakery;uid=root;pwd=YOUR-PASSWORD-HERE;"
    }
}

2. Where you see "YOUR-PASSWORD-HERE" is where you put the password you created for your MySQL server. Your server name and port might vary depending on your local system. Check MySQL Workbench Connections to determine if the local host and port number match and adjust as needed.

3. If doing any editing or adding to the project, create a .gitignore file and add the following files & folders to it:

• obj/
• bin/
• .vscode/
• .DS_Store
• appsettings.json

Import Database in MySQL Workbench

1. Open MySQL Workbench and a Terminal/CMD. Run the command line mysql -uroot-p[YOUR-PASSWORD] with your password in the proper place to open a server.
2. From the top navigation bar, select 'Server' > 'Data Import'.
3. Select the option 'Import from Self-Contained File'.
4. Click the '...' button to navigate to the project file folder TravelAPI and select danielle_thompson_travel.sql.
5. Set 'Default Target Schema' or create new schema.
6. Select the schema objects you would like to import
7. To finalize, click 'Start Import'.

Import Database with Entity Framework Core

1. From your Terminal/CMD, navigate to the root directory of the project: cd Desktop/TravelAPI.Solution/TravelAPI.
2. Run the command dotnet ef database update to create the database on your local system.
3. If any updates to the database are needed with code changes, run dotnet ef migrations add <NewMigrationNameHere>, then dotnet ef database update to complete the update.

API Documentation

Feel free to explore the API endpoints in Postman. Base URL: http://localhost:5004

Accessing the SwaggerUI

Launch the project from the TravelAPI project folder by typing dotnet run into the terminal. Input http://localhost:5004/swagger to view and interact with the Swashbuckle SwaggerUI.

---