https://github.com/mohammadbekran/textloom
A full-stack application with Next.js, TypeScript, Prisma, Hono.js, React Query
https://github.com/mohammadbekran/textloom
honojs nextjs prisma reactjs shadcn tailwindcss tanstack-react-query typescript
Last synced: 22 days ago
JSON representation
A full-stack application with Next.js, TypeScript, Prisma, Hono.js, React Query
- Host: GitHub
- URL: https://github.com/mohammadbekran/textloom
- Owner: MohammadBekran
- Created: 2025-01-10T06:23:01.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-04-08T12:11:21.000Z (23 days ago)
- Last Synced: 2025-04-08T12:33:34.378Z (23 days ago)
- Topics: honojs, nextjs, prisma, reactjs, shadcn, tailwindcss, tanstack-react-query, typescript
- Language: TypeScript
- Homepage: https://textloom.vercel.app
- Size: 1.29 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Textloom
Textloom is a full-stack web application designed to streamline content creation and management for digital marketers. It leverages modern technologies to provide a seamless user experience.
**Live Demo:** [https://textloom.vercel.app](https://textloom.vercel.app)
## Table of Contents
- [Features](#features)
- [Technologies Used](#technologies-used)
- [Installation Guide](#installation-guide)
- [Usage Instructions](#usage-instructions)
- [Contributing](#contributing)
- [License](#license)
- [Contact Information](#contact-information)
## Features
- **User Authentication:** Secure login and registration system.
- **Content Management:** Create, edit, and organize content seamlessly.
- **Real-time Collaboration:** Collaborate with team members in real-time.
- **Analytics Dashboard:** See all of the documents, manage them with advance searching
## Technologies Used
- **Frontend:**
- Next.js: A React framework for building server-side rendered applications.
- TypeScript: A superset of JavaScript that adds static typing.
- Tailwind CSS: A utility-first CSS framework for rapid UI development.
- **Backend:**
- Hono.js: A fast and minimal web framework for building APIs.
- Prisma: An ORM for Node.js and TypeScript, providing a type-safe database client.
- **State Management:**
- React Query: A data-fetching and state management library for React.
## Installation Guide
To set up the project locally:
1. **Clone the Repository:**
```bash
git clone https://github.com/MohammadBekran/textloom.git
# TextLoom
## Installation Guide
### Navigate to the Project Directory:
```bash
cd textloom
```
### Install Dependencies:
#### Using npm:
```bash
npm install
```
#### Or using yarn:
```bash
yarn install
```
### Set Up Environment Variables:
Create a `.env` file in the root directory and add the necessary environment variables. Refer to `.env.example` for the required variables.
### Run the Development Server:
#### Using npm:
```bash
npm run dev
```
#### Or using yarn:
```bash
yarn dev
```
Visit [http://localhost:3000](http://localhost:3000) in your browser to view the application.
## Usage Instructions
### Starting the Development Server:
Follow the steps in the Installation Guide to set up the development environment.
### Building for Production:
To create an optimized production build, run:
#### Using npm:
```bash
npm run build
```
#### Or using yarn:
```bash
yarn build
```
### Running Tests:
Execute the following to run the test suite:
#### Using npm:
```bash
npm run test
```
#### Or using yarn:
```bash
yarn test
```
## Contributing
Contributions are welcome! To contribute:
### Fork the Repository:
Click the "Fork" button at the top right corner of this page.
### Clone Your Fork:
Clone your forked repository to your local machine.
### Create a New Branch:
```bash
git checkout -b feature/your-feature-name
```
### Make Changes:
Implement your changes or add new features.
### Commit Changes:
Stage and commit your changes with clear messages.
```bash
git add .
git commit -m "Add feature: your feature name"
```
### Push Changes:
Push your changes to your forked repository.
```bash
git push origin feature/your-feature-name
```
### Create a Pull Request:
Open a pull request from your feature branch to the main repository's main branch.
Please ensure that your code adheres to the project's coding standards and includes appropriate tests.
## License
This project is licensed under the MIT License.
## Contact Information
- **Email**: [email protected]
- **LinkedIn**: [linkedin.com/in/mohammad-bekran](https://linkedin.com/in/mohammad-bekran)