BookLibraryProject

This is a full stack application, this repository contains the Frontend and the backend is here

Presentation

ReadSphere: Your Personalized Short Stories and Book Library Platform

ReadSphere is designed to help you explore, organize, and track your reading journey with ease.

Featuring a sleek interface, curated book recommendations, and an exciting integration with OpenAI to generate your own short stories, ReadSphere makes it effortless to discover books and stories tailored to your unique interests.

Whether you're searching by title, author, or genre, or exploring top-rated reads, ReadSphere is your ultimate companion for all things reading.

Although ReadSphere is still in development, you can already take a sneak peek and start enjoying its features. Dive in and explore! readsphere.vercel.app

The backend is implemented using Entity Framework code first approach throw TDD using xUnit framework and Mock library.

Installation and Setup

Backend

1. Clone the Backend Repository:

   git clone https://github.com/PhilippeLeopoldie/bookLibraryBackend.git

2. Navigate to the Backend Directory:

   cd bookLibraryBackend

3. Install Global Tools:

   dotnet tool install -g dotnet-aspnet-codegenerator
   dotnet tool install -g dotnet-ef

4. Install Dependencies:

   dotnet restore

5. Add Entity Framework Tools:

   dotnet add package Microsoft.EntityFrameworkCore.Tools -version 9.0.0

6. Add Entity Framework Design:

   dotnet add package Microsoft.EntityFrameworkCore.Design -version 9.0.0

7. Add CodeGeneration.Design (if needed):

   dotnet add package Microsoft.VisualStudio.Web.CodeGeneration.Design -version 9.0.0

8. Add Database Provider (Choose one):

   dotnet add package Npgsql.EntityFrameworkCore.PostgreSQL -version 9.0.2

9. Run the Backend Locally:

   dotnet run

   • The backend should now be running at:
     • HTTP: http://localhost:5281
     • Swagger UI: http://localhost:5281/swagger/index.html

Frontend

Note: Ensure you have installed:

• Node.js version: 18.15.0
• npm version: 9.5.0

1. Clone the Frontend Repository:

   git clone https://github.com/PhilippeLeopoldie/BooksLibraryProject.git

2. Navigate to the Frontend Directory:

   cd BooksLibraryProject/frontend/LibraryFrontEnd

3. Install Vite:

   npm install -g create-vite

4. Update the API URL in URLs.ts:

   • Open the src/URLs.ts file.

   • Locate the API_URL variable and update it with the appropriate API URL for local or deployment environment.

     • For local environment:

     export const API_URL : string = "https://localhost:7152/api/"

     • For deployment environment:

     export const API_URL : string = "https://booklibrary-backend-20f7a19cecb2.herokuapp.com/api/" 

5. Install Dependencies:

   npm install

6. Run the Frontend Locally:

   npm run dev

   • The frontend should now be running locally.

App Home page:

Technologies

Backend

Backend repository

• .Net 9.0.0

• C# 13

• ASP.NET Core Web APIs

• xUnit 2.9.2

• Moq 4.20.72

• API platform: Heroku

• Database platform: Vercel

  • Database : postGres

Frontend

Frontend repository

• platform: Vercel

• Node.js 18.15.0 , npm 9.5.0

• React 18.2.0

• TypeScript 4.9.3

• CSS

• HTML

• Jest 29.7.0

Deploying link

readsphere.vercel.app