Veritas Opus - The Truth is the Work

A professional web application for creating, editing, and managing shared documents with ease and security 🚀.

Table of Contents

• Introduction
• Features
• Technologies
• Installation
• Usage
• Contributing
• Contact

Introduction

Veritas Opus is a professional web application that empowers users to create, edit, and manage shared documents. Built with Next.js, a powerful React framework, Veritas Opus leverages ConvexDB as the database for document storage and Edge store, a decentralized storage network, for image storage. User authentication and management are seamlessly handled by Clerk, a robust user authentication and management service. The application is deployed on Vercel, ensuring a reliable and scalable hosting solution. With a sleek and modern user interface powered by Tailwind CSS and the shadcn/ui library, Veritas Opus provides an intuitive and delightful user experience.

Features

• Create, edit, and delete documents with ease
• Seamlessly share documents with other users
• Effortlessly upload and store images
• Secure user authentication and management
• Reliable decentralized file storage

Technologies

• Next.js: A powerful React framework for building web applications
• ConvexDB: A robust database for efficient document storage
• Edge store: A decentralized storage network for secure file storage and sharing
• Clerk: A user authentication and management service for seamless user experience
• Vercel: A reliable and scalable hosting platform for deploying web applications
• BlockNote: A note-taking application for enhanced productivity
• Tailwind CSS: A utility-first CSS framework for building modern user interfaces
• shadcn/ui: A comprehensive library for building sleek and modern UI components
• React: A JavaScript library for building user interfaces
• TypeScript: A typed superset of JavaScript for enhanced development experience
• Zustand: A lightweight state management solution for React applications
• Radix: A design system for building consistent and accessible user interfaces

Installation

To install Veritas Opus, ensure that you have Node.js installed on your machine. Follow the steps below:

1. Clone the repository by running the following command in your terminal:

   git clone https://github.com/Rajkumar-Khatua/Veritas-Opus---The-Truth-is-the-Work.git

2. Navigate to the project directory:

   cd Veritas-Opus---The-Truth-is-the-Work

3. Install the required dependencies:

   npm install

4. Run the application:

   npm run dev

5. Open your browser and navigate to http://localhost:3000 to view the application.

Usage

To use Veritas Opus, follow the steps below:

1. Create an account or sign in to your existing account.
2. Create a new document by clicking the "New Document" button.
3. Edit the document by adding, removing, or modifying the content.
4. Share the document with other users by clicking the "Publish" button and also can make it unpublished.
5. Upload cover image by clicking the "Add cover image" button and selecting the desired image file.
6. View and manage your documents by clicking the "Documents" button in the navigation bar.

Contributing

Contributions are welcome! To contribute to Veritas Opus, follow the steps below:

1. Fork the repository by clicking the "Fork" button.

2. Clone the repository to your local machine:

   git clone https://github.com/Rajkumar-Khatua/Veritas-Opus---The-Truth-is-the-Work.git

3. Create a new branch:

   git checkout -b feature/my-feature

4. Make your changes and commit them:

    git commit -m "Add my feature"

5. Push your changes to the branch:

   git push origin feature/my-feature

6. Create a pull request by clicking the "Pull Request" button.

Contact

If you have any questions or need further assistance, please feel free to reach out to me via LinkedIn:

• Rajkumar Khatua

Thank you for taking the time to read our documentation! We appreciate your interest in Veritas Opus. If you have any questions or need further assistance, please don't hesitate to reach out to us. We are here to help! 😊