Feature: Enhanced Documentation and Environment Setup for Devablos Project V2

[HlexNC]

Description

This pull request enhances the documentation and environment setup for the Devablos Project V2. Key improvements include updated README files for the main project, client, and server directories, detailed environment setup instructions, and clear guidelines for running the application locally and with Docker.

Key Changes

1. Main README:

   • Added an overview of the project's key features.
   • Updated the directory structure.
   • Included quick start instructions for environment setup and running the application.
   • Provided links to specific README files for more detailed instructions.

2. Client README:

   • Described the key features of the client application.
   • Updated the directory structure to reflect the current setup.
   • Provided clear instructions for installing dependencies, running locally, and building for production.
   • Included a section on Dockerization.

3. Server README:

   • Described the key features of the server application.
   • Updated the directory structure to reflect the current setup.
   • Provided clear instructions for installing dependencies, running locally, and setting environment variables.
   • Included a section on Dockerization and API documentation.

4. Environment Variables:

   • Updated .env.example files for both client and server to include necessary configurations and additional comments for clarity.

5. Web Content and Metadata:

   • Improved the HTML metadata in index.html for better SEO and social media integration.
   • Added Open Graph and Twitter meta tags for enhanced link previews.

6. Visual Enhancements:

   • Added new images and icons for better visual appeal and branding.
   • Updated the client application with a new banner and logos.

These updates provide a comprehensive and user-friendly guide to setting up and running the Devablos Project V2, making it easier for developers to contribute and users to understand the project's capabilities.

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

OpenSSF Scorecard

Package	Version	Score	Details

Scanned Manifest Files