{"id":18633104,"url":"https://github.com/hpatricioh/markdown-editor","last_synced_at":"2026-05-06T19:04:40.801Z","repository":{"id":208555722,"uuid":"721922694","full_name":"HpatricioH/markdown-editor","owner":"HpatricioH","description":"Markdown Editor is an application to create markdown files online","archived":false,"fork":false,"pushed_at":"2024-02-06T03:24:11.000Z","size":420,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-27T08:08:49.111Z","etag":null,"topics":["nextjs","playwright","pnpm","tailwindcss","typescript"],"latest_commit_sha":null,"homepage":"https://markdown-editor-cyan-five.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/HpatricioH.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2023-11-22T03:58:30.000Z","updated_at":"2024-02-07T03:12:42.000Z","dependencies_parsed_at":"2023-12-07T05:24:06.398Z","dependency_job_id":"137526dd-ea77-4e19-b85b-302cee651021","html_url":"https://github.com/HpatricioH/markdown-editor","commit_stats":null,"previous_names":["hpatricioh/markdown-editor"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HpatricioH%2Fmarkdown-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HpatricioH%2Fmarkdown-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HpatricioH%2Fmarkdown-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/HpatricioH%2Fmarkdown-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/HpatricioH","download_url":"https://codeload.github.com/HpatricioH/markdown-editor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239428150,"owners_count":19636899,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["nextjs","playwright","pnpm","tailwindcss","typescript"],"created_at":"2024-11-07T05:14:21.928Z","updated_at":"2025-11-04T08:30:29.008Z","avatar_url":"https://github.com/HpatricioH.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://bill-generator-kappa.vercel.app/\" style=\"text-decoration: none;\"\u003e\n    \u003cimg src=\"public/images/logo.png\" alt=\"Markdown\" height=\"200\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# Markdown Editor\n\nThis project is a Markdown Editor, meticulously crafted with the powerful combination of Next.js, TypeScript, NextAuth.js, Zustand, and server side components. Originally sourced from a personal project, this Markdown Editor was developed with the primary goal of honing development skills and gaining practical experience.\n\nThis Markdown Editor is designed to be a versatile tool for anyone seeking a quick and efficient way to create and edit Markdown documents. It's more than just a digital canvas—it's a comprehensive solution for managing and organizing your Markdown files. The project's roadmap includes plans for expansion, introducing user authentication features and various other enhancements in the future.\n\n## Table of Contents\n\n- [Getting Started](#getting-started)\n- [Built With](#built-with)\n- [Prerequisites](#Prerequisites)\n\n## Screenshot\n\n![Project Screenshot](screenshot.png)\n\n### Built with\n\n- Semantic HTML5 markup\n- Zustand\n- Mobile-first approach\n- Responsive design\n- [Next JS](https://nextjs.org/) - JS library\n- [TypeScript](https://www.typescriptlang.org/)\n- [TailwindCSS](https://tailwindcss.com/) - For styles\n- [Vercel](https://vercel.com/) - Deployment\n\n## Local Development Setup\nMarkdown Editor is fully on your computer and requires each dependency (for example MongoDB) to be installed in order to start the local development.\n\n### 0. Prerequisites\n* [Mongodb](https://www.mongodb.com/)\n* Follow the instructions in the [MongoDB setup guide](MONGODB_GUIDE.md) to set up your MongoDB Atlas database.\n* [Google Cloud](https://cloud.google.com/)\n* Follow the instructions in the [Google Cloud setup guide](GOOGLE_SETUP.md) to set up your Google Cloud project.\n\n\n### 1. Fork and clone the repository\n\nFollow [these steps](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo) to create a fork of this repository and then clone it to your local machine. \n\n```shell\ngit clone https://github.com/HpatricioH/markdown-editor.git\n```\n\n### 2. Navigate to the repo directory\n\nAfter cloning move into the cloned repo:\n\n```shell\ncd markdown-editor\n```\n\n### 3. Install dependencies\n\n#### Installing `node`:\n\nIf you have node already installed in your computer you can avoid this step. To install `node` [download the installer](https://nodejs.org/en/) from their site. Please download the lates and [LTS version](https://nodejs.org/en).\n\n#### Installing `pnpm`:\n\n`pnpm` is a package manager that is used to install all dependencies needed.\n\nIf you would like to read more about `pnpm` you can visit [their documentation](https://pnpm.io/motivation).\n\nThe best way to install `pnpm` for this project is by using [Corepack](https://nodejs.org/api/corepack.html), a new feature bundled with Node.\n\nInstall pnpm with the following commands (there are more ways to install 'pnpm' if you prefer to use a different method please visit [pnpm's installation page](https://pnpm.io/installation)):\n\n```sh\nnpm install -g pnpm\n```\n\n#### Setting up your .env\n\nUse the following command to create a local `.env` file. Then open the new file (`.env`) to make any changes required in the document.\n\n```shell\ncp .env.example .env\n```\n\n#### Installing package dependencies\n\nOnce you have `node`, `pnpm` installed, please run the following command to install all dependencies:\n\n```shell\npnpm install\n```\n\nAfter running the command above, you should see a `node_modules` folder in your project root. This is where all the dependencies are installed. At this point you can run the project locally using the following command:\n\n```shell\npnpm dev\n```\n\nOnce you run this command, a local server is running at http://localhost:3000 any changes that you make to the code will be reflected on the browser automatically.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhpatricioh%2Fmarkdown-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhpatricioh%2Fmarkdown-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhpatricioh%2Fmarkdown-editor/lists"}