From f11a7b3fb0252f6e5110cf06e7da140d310ba202 Mon Sep 17 00:00:00 2001 From: donavon04 Date: Tue, 10 Dec 2024 16:39:05 -0700 Subject: [PATCH] Added README --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..74f003d --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# DocuCenter + +DocuCenter is a powerful and fast documentation web app designed to help you organize, search, and manage your documentation effortlessly. With its robust search engine and intuitive tagging system, DocuCenter makes finding and categorizing your documents easier than ever. + +## Features + +- **Fast Search Engine**: Quickly search through titles, bodies, and tags of documents with our optimized and highly efficient search system. +- **Tagging System**: Use tags to categorize your documents for better organization and retrieval. +- **MongoDB Backend**: Utilizes MongoDB as the backend for scalable and flexible document storage. +- **Easy to Use Interface**: Simple and intuitive UI to create, read, update, and delete documents. +- **Secure**: Built with security in mind to protect your data and ensure that your documents are safe. +- **Lightweight**: Built for speed and performance, ensuring fast load times even with a large number of documents. + +## Tech Stack + +- **Frontend**: Built with [Svelte](https://svelte.dev/) for a reactive and fast user interface. +- **Backend**: Node.js and Express.js to handle API requests and logic. +- **Database**: MongoDB for flexible document storage with full-text search capabilities. +- **Styling**: Tailwind CSS for easy-to-style and responsive design. + +## Installation + +### Prerequisites + +To run DocuCenter locally, you'll need: + +- Node.js (v16 or higher) +- MongoDB (local or remote instance) + +### Steps + +1. Clone the repository: + + ```bash + git clone https://github.com/yourusername/docucenter.git + cd docucenter