LIBRARY API

❯ Library API

Built with .Net Core and technologies:

Table of Contents

• Overview
• Features
• Repository Structure
• Modules
• Getting Started
  • Prerequisites
  • Installation
  • Usage
  • Tests
• Project Roadmap
• Contributing
• License
• Acknowledgments

---

Overview

❯ Had built api in order to serve services for library management apps.

---

Features

❯ SOON...

---

Repository Structure

└── LibraryAPI/
    ├── LibraryAPI  
    │   ├── LibraryAPI
    │   │   ├── Controllers
    │   │   │   └── Concrete
    │   │   │       ├── AuthenticationController.cs
    │   │   │       ├── AuthorRepresentativeBooksController.cs
    │   │   │       ├── AuthorsController.cs
    │   │   │       ├── BookLanguagesController.cs
    │   │   │       ├── BooksController.cs
    │   │   │       ├── CategoriesController.cs
    │   │   │       ├── DisLikeController.cs
    │   │   │       ├── DonatorsController.cs
    │   │   │       ├── EmployeesController.cs
    │   │   │       ├── FavouritesController.cs
    │   │   │       ├── LanguagesController.cs
    │   │   │       ├── LibrariesController.cs
    │   │   │       ├── LibraryRepresentativeBookStocksController.cs
    │   │   │       ├── LikesController.cs
    │   │   │       ├── LocationsController.cs
    │   │   │       ├── MembersController.cs
    │   │   │       ├── PublisherEMailsController.cs
    │   │   │       ├── PublisherPhonesController.cs
    │   │   │       ├── PublisherRepresentativeBooksController.cs
    │   │   │       ├── PublishersController.cs
    │   │   │       ├── RepresentativeBookCategoriesSubCategoriesController.cs
    │   │   │       ├── RepresentativeBooksController.cs
    │   │   │       ├── RepresentativeBooksRatingController.cs
    │   │   │       ├── RolesController.cs
    │   │   │       ├── SubCategoriesController.cs
    │   │   │       └── TransactionsController.cs
    │   │   ├── Data
    │   │   │   └── ApplicationContext.cs
    │   │   ├── Models
    │   │   │   ├── Abstract
    │   │   │   │   ├── AbstractCategory.cs
    │   │   │   │   ├── AbstractLike.cs
    │   │   │   │   └── AbstractPerson.cs
    │   │   │   └── Concrete
    │   │   │       ├── ApplicationUser.cs
    │   │   │       ├── Author.cs
    │   │   │       ├── AuthorRepresentativeBook.cs
    │   │   │       ├── Book.cs
    │   │   │       ├── BookLanguage.cs
    │   │   │       ├── Category.cs
    │   │   │       ├── DisLike.cs
    │   │   │       ├── Donator.cs
    │   │   │       ├── Employee.cs
    │   │   │       ├── Favourite.cs
    │   │   │       ├── Language.cs
    │   │   │       ├── Library.cs
    │   │   │       ├── LibraryRepresentativeBookStock.cs
    │   │   │       ├── Like.cs
    │   │   │       ├── Location.cs
    │   │   │       ├── Member.cs
    │   │   │       ├── Publisher.cs
    │   │   │       ├── PublisherEMail.cs
    │   │   │       ├── PublisherPhone.cs
    │   │   │       ├── PublisherRepresentativeBook.cs
    │   │   │       ├── RepresentativeBook.cs
    │   │   │       ├── RepresentativeBookCategorySubCategory.cs
    │   │   │       ├── RepresentativeBookRating.cs
    │   │   │       ├── SubCategory.cs
    │   │   │       └── Transaction.cs
    │   │   ├── Program.cs
    │   │   ├── Properties
                └── launchSettings.json

---

Modules

LibraryAPI

File	Summary
Program.cs	❯ MiddleWare

LibraryAPI.LibraryAPI.Properties

File	Summary
launchSettings.json	❯ LaunchSettings

LibraryAPI.LibraryAPI.Data

File	Summary
ApplicationContext.cs	❯ Data Layer

LibraryAPI.LibraryAPI.Models.Concrete

File	Summary
PublisherPhone.cs	❯ PublisherPhone
Publisher.cs	❯ Publisher
Location.cs	❯ Location
DisLike.cs	❯ DisLike
Member.cs	❯ Member
Book.cs	❯ Book
Favourite.cs	❯ Favourite
RepresentativeBookRating.cs	❯ RepresentativeBookRating
Like.cs	❯ Like
Donator.cs	❯ Donator
Transaction.cs	❯ Transaction
PublisherEMail.cs	❯ PublisherEMail
BookLanguage.cs	❯ BookLanguage
LibraryRepresentativeBookStock.cs	❯ LibraryRepresentativeBookStock
ApplicationUser.cs	❯ ApplicationUser
Category.cs	❯ Category
AuthorRepresentativeBook.cs	❯ AuthorRepresentativeBook
RepresentativeBookCategorySubCategory.cs	❯ RepresentativeBookCategorySubCategory
RepresentativeBook.cs	❯ RepresentativeBook
SubCategory.cs	❯ SubCategory
Employee.cs	❯ Employee
Language.cs	❯ Language
Author.cs	❯ Author
PublisherRepresentativeBook.cs	❯ PublisherRepresentativeBook

LibraryAPI.LibraryAPI.Models.Abstract

File	Summary
AbstractLike.cs	❯ AbstractLike
AbstractPerson.cs	❯ AbstractPerson
AbstractCategory.cs	❯ AbstractCategory

LibraryAPI.LibraryAPI.Controllers.Concrete

File	Summary
PublisherRepresentativeBooksController.cs	❯ PublisherRepresentativeBooksController
AuthorRepresentativeBooksController.cs	❯ AuthorRepresentativeBooksController
RepresentativeBookCategoriesSubCategoriesController.cs	❯ RepresentativeBookCategoriesSubCategoriesController
AuthorsController.cs	❯ AuthorsController
TransactionsController.cs	❯ TransactionsController
CategoriesController.cs	❯ CategoriesController
FavouritesController.cs	❯ FavouritesController
RepresentativeBooksController.cs	❯ RepresentativeBooksController
RepresentativeBooksRatingController.cs	❯ RepresentativeBooksRatingController
DisLikeController.cs	❯ DisLikeController
LibrariesController.cs	❯ LibrariesController
LanguagesController.cs	❯ LanguagesController
BookLanguagesController.cs	❯ BookLanguagesController
DonatorsController.cs	❯ DonatorsController
MembersController.cs	❯ MembersController
LocationsController.cs	❯ LocationsController
AuthenticationController.cs	❯ AuthenticationController
LikesController.cs	❯ LikesController
LibraryRepresentativeBookStocksController.cs	❯ LibraryRepresentativeBookStocksController
PublishersController.cs	❯ PublishersController
EmployeesController.cs	❯ EmployeesController
PublisherEMailsController.cs	❯ PublisherEMailsController
BooksController.cs	❯ BooksController
SubCategoriesController.cs	❯ SubCategoriesController
RolesController.cs	❯ RolesController
PublisherPhonesController.cs	❯ PublisherPhonesController

---

Getting Started

Prerequisites

.Net Core: 6.0

Installation

Build the project from source:

1. Clone the LibraryAPI repository:

❯ git clone https://github.com/suaybdemir/LibraryAPI

2. Navigate to the project directory:

❯ cd LibraryAPI

3. Install the required dependencies:

❯ dotnet build

Usage

To run the project, execute the following command:

❯ dotnet run

Tests

Execute the test suite using the following command:

❯ dotnet test

---

Project Roadmap

• Task 1: Implement feature one.
• Task 2: Implement feature two.
• Task 3: Implement feature three.

---

Contributing

Contributions are welcome! Here are several ways you can contribute:

• Report Issues: Submit bugs found or log feature requests for the LibraryAPI project.
• Submit Pull Requests: Review open PRs, and submit your own PRs.
• Join the Discussions: Share your insights, provide feedback, or ask questions.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your github account.
2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/suaybdemir/LibraryAPI

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.
5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to github: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.
8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

Acknowledgments

• Soon

---