https://github.com/mmabiaa/docugenius
https://github.com/mmabiaa/docugenius
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mmabiaa/docugenius
- Owner: Mmabiaa
- Created: 2025-05-19T20:55:42.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-05-20T00:00:54.000Z (5 months ago)
- Last Synced: 2025-06-27T14:09:37.756Z (4 months ago)
- Language: TypeScript
- Homepage: https://docu-genius-blush.vercel.app
- Size: 126 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# DocuGenius
A modern document generation and management platform built with React, TypeScript, and Tailwind CSS.
## Features
- Academic Paper Generation
- Resume Builder
- Document History
- Multiple Citation Styles
- Real-time Collaboration
- Template Management
- User Authentication
- Responsive Design
## Tech Stack
- React
- TypeScript
- Tailwind CSS
- React Router
- Supabase
- React Icons
## Getting Started
### Prerequisites
- Node.js (v14 or higher)
- npm or yarn
- Git
### Installation
1. Clone the repository:
```bash
git clone https://github.com/mmabiaa/docugenius.git
cd docugenius
```
2. Install dependencies:
```bash
npm install
# or
yarn install
```
3. Create a `.env` file in the root directory and add your environment variables:
```env
VITE_SUPABASE_URL=your_supabase_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key
```
4. Start the development server:
```bash
npm run dev
# or
yarn dev
```
## Project Structure
```
src/
├── components/ # Reusable components
├── context/ # React context providers
├── pages/ # Page components
├── lib/ # Utility functions and configurations
├── types/ # TypeScript type definitions
└── App.tsx # Main application component
```
## Contributing
1. Fork the repository
2. Create your feature branch (`git checkout -b feature/amazing-feature`)
3. Commit your changes (`git commit -m 'Add some amazing feature'`)
4. Push to the branch (`git push origin feature/amazing-feature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contact
Your Name - [@yourtwitter](https://twitter.com/mmabiaa)
Project Link: [https://github.com/mmabiaa/docugenius](https://github.com/mmabiaa/docugenius)