Muswaddaty is an open-source, block-based, collaborative online text editor inspired by Notion. It offers a rich and intuitive user interface for creating and editing content collaboratively.
Version: 0.1.0
Muswaddaty is an open-source, block-based, collaborative online text editor inspired by Notion. It offers a rich and intuitive user interface for creating and editing content collaboratively.
You can try out Muswaddaty online here.
To run Muswaddaty locally, you'll need the following:
You'll also need to sign up for the following services:
Muswaddaty is built with the following technologies:
To get started with Muswaddaty, follow these steps:
git clone https://github.com/mohamed-lifa7/muswaddaty.git
cd muswaddaty
pnpm install
Create a .env
file in the root directory and add your environment variables. Refer to .env.example
for required variables.
pnpm run db:push
pnpm postinstall
pnpm run dev
Once the development server is running, you can access the application at http://localhost:3000
. Here are some basic operations you can perform:
Here are some useful scripts you can use during development:
pnpm run build
: Build the project for production.pnpm run db:push
: Push the Prisma schema to the database.pnpm run db:studio
: Open Prisma Studio for database management.pnpm run dev
: Start the development server.pnpm run lint
: Run ESLint to check for linting errors.pnpm run lint:fix
: Fix linting errors automatically.pnpm run start
: Start the production server.We welcome contributions from the community! To contribute to Muswaddaty, follow these steps:
git checkout -b feature/your-feature-name
git commit -m 'Add some feature'
git push origin feature/your-feature-name
Please ensure your code adheres to the project's coding standards and passes all tests.
This project is licensed under the MIT License. See the LICENSE file for more details.
If you have any questions or suggestions, feel free to reach out to us:
Email: [email protected]
GitHub: Mohamed-lifa7
Or one of these :
Graduation poject framer Dr. Zaiz Fouazi
Project Contributor Ahmed Hafsi
Thank you for using Muswaddaty!