markdown zen

Markdown Zen

MarkdownZen é um aplicativo web desenvolvido para agilizar a criação e gerenciamento de documentos de remarcação. Com uma interface amigável e recursos poderosos, MarkdownZen é a ferramenta ideal para uma experiência de remarcação zen.

Índice

• Começando
  • Pré-requisitos
  • Instalação
• Uso
• Características
• Executando com Docker
• Contribuindo
• Licença

Começando

Pré-requisitos

Antes de começar, certifique-se de ter o seguinte software instalado em seu computador:

• Node.js
• npm (gerenciador de pacotes de nós)

Instalação

1. Clone o repositório :

   Abra seu terminal/prompt de comando e navegue até o local onde deseja armazenar o projeto. Em seguida, execute o seguinte comando:

git clone https://github.com/daniel752/markdown-zen.git

Isso fará o download dos arquivos do projeto para o seu computador.

2. Navegue até a pasta do projeto :

Use o comando cd para alterar seu diretório de trabalho para a pasta do projeto clonado:

cd markdown-zen

3. Instalar dependências :

Dentro da pasta do projeto, instale as dependências necessárias tanto para o servidor quanto para o cliente usando um único comando:

npm run setup-project

Isso instalará os pacotes necessários para os componentes de servidor e cliente do aplicativo.

Uso

1. Inicie o aplicativo :

Para iniciar o aplicativo, execute o seguinte comando na pasta raiz (markdown-zen/):

npm run dev

Este comando inicia o servidor e o cliente simultaneamente, para que você possa acessar o aplicativo em seu navegador.

2. Acesse o aplicativo :

Abra seu navegador e vá para http://localhost:5173 . É aqui que você encontrará o aplicativo MarkdownZen.

3. Criação e gerenciamento de remarcações :

• Faça login ou crie uma conta.
• Comece a criar e gerenciar seus documentos de descontos sem esforço.

Características

• Crie, edite e gerencie documentos de descontos com facilidade.
• Visualização de redução em tempo real durante a edição.
• Organize remarcações usando categorias e tags.
• Sistema seguro de autenticação e autorização.
• ...

Executando com Docker

Você também pode executar MarkdownZen usando Docker. Siga estas etapas:

1. Extraia a imagem do Docker :

   Extraia a imagem MarkdownZen Docker do Docker Hub:

   docker pull daniel752/markdown-zen:v1.0.0
   

2. Execute o contêiner :

   Inicie o contêiner MarkdownZen:

   docker run -d daniel752/markdown-zen:v1.0.0
   
   

• -d: Execute o contêiner em modo desanexado (em segundo plano).
• O contêiner operará na porta 8000 internamente e 5173 externamente.

Contribuindo

Aceitamos contribuições da comunidade! Para contribuir com o MarkdownZen, siga estas etapas:

1. Bifurque o repositório :

Clique no botão "Fork" no canto superior direito da página do repositório GitHub. Isso cria uma cópia do repositório na sua conta GitHub.

2. Clone seu garfo :

Clone seu repositório bifurcado em sua máquina local:

git clone https://github.com/your-username/markdown-zen.git

3. Crie uma nova filial :

Mude para o diretório do projeto:

cd markdown-zen

Crie um novo branch para seu recurso:

git checkout -b feature/my-new-feature

4. Faça alterações :

Faça as alterações necessárias e confirme-as:

git commit -m 'Add some feature'

5. Envie suas alterações :

Envie suas alterações para seu repositório bifurcado:

git push origin feature/my-new-feature

6. Envie uma solicitação pull :

Visite o repositório original no GitHub e clique no botão “Nova solicitação pull” para enviar suas alterações para revisão.

Licença

Este projeto está licenciado sob a licença MIT. Consulte o arquivo LICENSE para obter detalhes.