This application serves as an introduction to building an API with C#/.NET Core. The API is a public library book tracker. Users can update current stocks of little librairies and keep track of books they have checked out.
- Open Terminal (macOS) or PowerShell (Windows)
- To download the project Directory to your desktop enter the following commands:
cd Desktop
git clone https://github.com/jhvozdovich/little-free-library.git
cd little-free-library (or the file name you created for the main Directory of the download)
- To view the downloaded files, open them in a text editor or IDE of your choice.
- if you have VSCode for example, when your terminal is within the main project Directory you can open all of the files with the command:
code .
- Create a file within the Library folder named appsettings.json.
- Add the following code:
{
"ConnectionStrings": {
"DefaultConnection": "Server=localhost;Port=3306;database=library;uid=root;pwd=YOURMYSQLPASSWORDHERE;"
}
}
- Add your MySQL password and make any other changes needed if you have an alternative server, port, or uid selected. These are the default settings.
- Download the MySQL Community Server DMG file here with the "No thanks, just start my download" link.
- On the configuration page of the installer select the following options:
- Use legacy password encryption
- Set your password
- Open the terminal and enter the command: *'export PATH="/usr/local/mysql/bin:$PATH"' >> ~/.bash_profile
- Download the MySQL Workbench DMG file here
- Open Local Instance 3306 with the password you set.
- Open a terminal within your code editor.
- Navigate to the Library folder with the following command:
cd Library
- Run the following command to recreate the project's database structure:
dotnet ef database update
- Verify that the database structure is present by refreshing the MySQL workbench schemas. There should now be a directory for library.
To install the necessary dependencies and start a local host, after replicating the database run the following commands:
dotnet restore
dotnet build
dotnet run
No bugs have been identified at the time of this update. Passwords requirements are currently reduced for testing.
Please contact me with any suggestions or questions at jhvozdovich@gmail.com. Thank you for your input!
Have a bug or an issue with this application? Open a new issue here on GitHub.
- C#
ASP.NETCoreASP.NETCore MVC- Entity Framework Core
- MySQL
- Git and GitHub
| Spec | Input | Output |
|---|---|---|
| User enters home page | User Input:"URL: localhost:5000/" | Output: “Welcome!” |
| User can view book descriptions and see locations | User Input:"Click: Howl's Moving Castle" | Output: “Author: Dianna Wynne Jones, Condition: Good, Locations: Charter 98701, Charter 23646 ” |
| User can view the books available at a certain location and information | User Input:"Charter 23646" | Output: “Location 88th & Oak, 8885 Nw Oak St, Portland OR 97229, Books: Howl's Moving Castle, The Cruel Prince, Six of Crows” |
| User can add a book | User Input:"Click: Add Book" | Output: “Add Book Form: Title: Howl's Moving Castle, Author: Dianna Wynne Jones, Condition: Good, Location: Charter 98701, Book ID: Auto Incremented” |
| User can add a book to a location | User Input:"Click: Dropoff" | Output: Dropoff form: Book ID” |
| User can add location | User Input:"Click: Add Library" | Output: Add library form: Address: Location 88th & Oak, 8885 Nw Oak St, Portland OR 97229, Charter ID: Auto Incremented” |
| User can update books condition and availability | User Input:"Click: Book ID, Click: Update" | Output: “Condition and Location Form: Condition: Poor Location: Charter 98701” |
| User can delete books completely | User Input:"Your Contributions > Click Book > Click Remove" | Output: “Are you sure you want to take Six of Crows out of circulation? > Yes > Remove from database” |
| User can search for a book by title | User Input:"Search by title: Howl's Moving Castle" | Output: "Title: Howl's Moving Castle, Author: Dianna Wynne Jones, Condition: Good, Location: Charter 98701, Book ID: Auto Incremented” |
| User can search for a book by author | User Input:"Search by author: Dianna Wynne Jones" | Output: "Title: Howl's Moving Castle, Author: Dianna Wynne Jones, Condition: Good, Location: Charter 98701, Book ID: Auto Incremented” |
| User can search for a book by id | User Input:"Search by id: 1" | Output: "Title: Howl's Moving Castle, Author: Dianna Wynne Jones, Condition: Good, Location: Charter 98701, Book ID: Auto Incremented” |
| User can search for a little library location by charter name | User Input: "Name: 67860" | Output: “Name: Charter 67860, Address = "113 se 28th ave, Portland OR 97214", Latitude = 45.521F, Longitude = -122.637F” |
| User can search for a little library location by longitude and latitude | User Input: "Latitude = 45.521F, Longitude = -122.637F" | Output: “Name: Charter 67860, Address = "113 se 28th ave, Portland OR 97214", Latitude = 45.521F, Longitude = -122.637F” |
| User can search for a little library location by address | User Input: "113 se 28th ave, Portland OR 97214" | Output: “Name: Charter 67860, Address = "113 se 28th ave, Portland OR 97214", Latitude = 45.521F, Longitude = -122.637F” |
| Spec | Input | Output |
|---|---|---|
| User can delete books available at a location when checked out | User Input:"Click: Charter 23646, Click: Checkout, Click: Six of Crows" | Output: “Available books: Howl's Moving Castle, The Cruel Prince” |
| User can delete books completely if they are the original owners | User Input:"Your Contributions > Click Book > Click Remove" | Output: “Are you sure you want to take Six of Crows out of circulation? > Yes > Remove from database” |
| User can look up random books | User Input:"Find random book" | Output: “Title: Howl's Moving Castle, Author: Dianna Wynne Jones, Condition: Good, Location: Charter 98701” |
| Data visualization of libraries the book has been | User Input:"Click: Howl's Moving Castle" | Output: “Map of book journey” |
| Include data about businesses or organizations that may be connected to a library | User Input: Follow link to business data | Output: Page now displays organization data. |
| Add a model for copies of books linked to book ID | Book: BookID, Title, Author | Copy: CopyID, BookID, Condition, CurrentLocation, Locations, Users |
- (Sample Data)[https://littlefreelibrary.org/ourmap/]
This software is licensed under the MIT license.
Copyright © 2020 Jessica Hvozdovich and Ethan Firpo