Capture, Collaborate, Create. Welcome to Write is your all-in-one platform for seamless collaboration and creativity.
Write is a powerful Markdown editor that allows you to write, edit, and share your documents with everyone.
Start by creating a new project, using a available template or starting from scratch. Next, you can write your document using the powerful Markdown editor. You can also add images, videos, and other files to your document.
If you are lost using Markdown, you can use the built-in Markdown toolbar to help you out.
To get a look at your document, you can use the preview mode to see how your document will look like when published, on the top right of the screen.
Once you are all done, you can pusblish your document to the web, and share it with everyone! You can also export your document to a PDF file.
- Real-time database
- Notion-style look and feel
- Publish your documents to the web
- Export your documents to a PDF file
- Trash can & soft delete, with recovery
- File upload
- Light and Dark mode
- Full mobile responsiveness
- Authentication
- Expandable sidebar
- Fully collapsable sidebar
- Landing page
- TypeScript, a typed superset of JavaScript
- Next.js, a React framework
- Tailwind CSS, a utility-first CSS framework
- shadcn/ui, a UI component library
- Clerk, an authentication library
- Convex, a serverless backend
- Edge Store, a serverless database to store blobs
- Bun, a build tool
- Zustand, a state management library
- Trunk, a code quality / security checking tool
Deployed on Vercel, backend on Convex and Edge Store.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
- Clone the repository
git clone https://github.com/NathanBrodin/Write.git
cd Write- Install the dependencies
(Install Bun if you haven't already), or use npm or yarn
curl -fsSL https://bun.sh/install | bashThen install the dependencies
bun install- Set up the environment variables
Create a .env.local file in the root of the project and add the following environment variables:
CONVEX_DEPLOYMENT=''
NEXT_PUBLIC_CONVEX_URL=''
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=''
CLERK_SECRET_KEY=''
EDGE_STORE_ACCESS_KEY=''
EDGE_STORE_SECRET_KEY=''For this, you will need to deploy a Convex backend and an Edge Store database. You can find the instructions for that in the Convex documentation the Edge Store documentation and the Clerk Documentation.
This will allow you to get your environment variables for the .env.local file.
- Run the backend server
bunx convex dev- Run the frontend server
bun run dev- Open http://localhost:3000 with your browser to see the result.
This project is licensed under the MIT License - see the LICENSE file for details.
Original code made using Code With Antonio's tutorial, which is a Notion Clone. I have then modified it to fit my needs and added a lot of new features!