Skip to content

TheDarkArtist/tda-docs-app

Repository files navigation

TDA-DOCS-APP

❯by TheDarkArtist

last-commit repo-top-language repo-language-count

🚀 TDA-DOCS-APP

The TDA-DOCS-APP is a modern, web-based document editing platform. Built using Next.js and leveraging the lightweight package manager Bun, this app offers an intuitive interface for creating, editing, and managing documents in a collaborative manner. It supports real-time updates and allows users to work in a seamless, browser-based environment.

With the ability to format text, add images, and perform document operations, this app brings a professional tool for document management with a fast and responsive user interface.

🔑 Key Features:

  • Real-time collaborative document editing
  • Fully responsive design optimized for all devices
  • Intuitive toolbar for text formatting and inserting content
  • Fast and lightweight architecture with Bun package manager

🚀 Getting Started

☑️ Prerequisites

Ensure that your environment meets the following prerequisites:

  • Programming Language: TypeScript
  • Package Manager: Bun

⚙️ Installation

To set up the tda-docs-app, follow these steps:

  1. Clone the repository:

    ❯ git clone https://github.com/TheDarkArtist/tda-docs-app/
  2. Navigate into the project directory:

    cd tda-docs-app
  3. Install dependencies using bun:

    ❯ bun install
  4. Run the development server:

    ❯ bun run dev

Visit: http://localhost:3000 in your browser to use the app

Live app url: https://tda-docs-app.vercel.app


🔰 Contributing

Contributing Guidelines
  1. Fork the Repository: Fork the project to your GitHub account.
  2. Clone Locally: Clone your fork:
    git clone https://github.com/TheDarkArtist/tda-docs-app/
  3. Create a New Branch: Work on a new branch with a descriptive name:
    git checkout -b new-feature-x
  4. Develop: Implement and test your changes.
  5. Commit Changes: Write clear commit messages.
    git commit -m 'Implemented new feature x.'
  6. Push: Push the branch to your repository.
    git push origin new-feature-x
  7. Submit PR: Create a PR with a clear explanation of your changes.
  8. Review: Once your PR is reviewed and approved, it will be merged.
Contributor Graph


This app mimics the key functionality of Google Docs, with a clean and simple document editor that's built for modern web standards.

About

A google like docs platform

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published