LuanRoger / VolumeVault

📖 Keep your books informations safe and sound.

Volume Vault

Keep your books informations safe and sound.

Features

• 📖 Save your books informations.
• 🔒 Authenticate with different users.
• 📷 Add cover image for books.
• 🖌️ Themes: Dark and light mode.
• 💬 Multi-language support.
• 🪢 Filter result.
• 🏅 Badges for users.

Stack overview

• 🖥️ UI build with Flutter and Material Desing 3
• 📡 Own designed REST API build with ASP.NET.
• 🔍 Fast search with Meilisearch.
• 🐋 Docker and Docker Compose support.
• 🔨 Multi environment build (development, sttaging, production).
• 🔥 Integration with Firebase Admim SDK.
• 🛣️ API versioning.
• 📤 Output cache.

Other techs, tools and libs

• Serilog.
• FluentValidation.
• AutoMapper.
• Entity Framework.
• Postgres.

Prerequisite

• Flutter
• Docker
• Docker Compose
• Firebase service

Front-end client

The front-end was build with Flutter and have a responsive interface using Responsive Framework package, was created interface for Mobile (480), Tablet (700) and Desktop (1000) screen sizes.

API Specifications (VolumeVaulInfra API)

The API manage books and badges, it integrates with Firebase to check the users, was create with ASP.NET using Entity Framework to CRUD into a Postgres database, while all operations is logged by Serilog.

The API have a versioning system especified on requests header and an internal cache system to improve the performance.

Endpoints

Cheke out the Postman collection to see all endpoints and examples:

Hug service

/book

• GET /
  • ?limitPerPage=10
  • ?sort=0
  • ?ascending=true
  • ?bookFormat=1
  • ?page=1
  • ?userId=0
• POST /

  • Has body

  • ?userId=0
• PUT /{bookID:int}
  • ?userId=0
• DELETE /{bookID:int}

/stats

• GET /
  • ?userId=0

/badge

• GET /
  • ?userId=0
• POST /
  • ?userId=0
• DELETE /{badgeID:int}
  • ?userId=0
• GET /archive
  • ?email=[e-mail]
• PUT /archive

  • Has body

• POST /archive

  • Has body

• DELETE /archive
  • ?email=[e-mail]
  • ?badgeCode=0

/auth

• GET /email/{userEmail}
• GET /id/{firebaseUserUid}
• GET /search
  • ?query={string}

Search service

/search

• GET /
  • ?userId=0
  • ?query={string}
  • ?limitPerSection=10

Setup

To setup the project (development/production environments) click here.

Screenshots

Deploy it