Skip to content

Latest commit

 

History

History
98 lines (68 loc) · 5.23 KB

README.md

File metadata and controls

98 lines (68 loc) · 5.23 KB
Raw

Markdown
 .mdShare

Best way to share your markdown files.

GitHub tag (latest SemVer) Coverage Status Build Status Tests Status Linter Status Commitizen friendly License

📄 Share and Collaborate Effortlessly with .mdShare

Tired of struggling to share and collaborate on Markdown files? Finding it cumbersome to manage multiple versions of the same document while working with others? Look no further! Introducing .mdShare, the ultimate self-hosted solution for hassle-free Markdown file sharing and collaboration.

💡 The Challenge: Sharing Markdown Files Made Difficult

The .mdShare Solution: Simplify Markdown File Sharing. Effortless Sharing: Upload your Markdown files with a few clicks, preserving all the formatting, making it convenient for you.

🚀 Getting Started

How to deploy locally:

  • make sure mongodb is running

  • set up variables in .env file, check table Settings

  • Install dependens:

    yarn install

  • Build your application:

    yarn build

  • Start the Node.js server:

    yarn start

  • And you can check the site on localhost:3000

Use the app (deploy to vercel and mongo atlas):

You can choose to use the hosted version (also don't forget to set up environment variables)

Deploy with Vercel
Deploy Mongo Cloud

⚙️ Settings

variable description
APP_URL URL of your application such as your domain https://example.com or http://localhost:3000 (needed for SEO and generate links)
MONGO_HOST host is the server where your mongodb server is running
MONGO_PORT port that mongodb server is listening on
MONGO_USER user is an account that is used to authenticate and access the database
MONGO_PASSWD password is used to authenticate the user who is accessing the database
MONGO_DATABASE name of the mongodb database that your application will connect to
MONGO_URI you can specify the connection string for a mongodb database instead of the previous variables (has higher priority, empty by default)

🔧 Tech Stack

  • TypeScript — syntactic superset of JavaScript which adds static typing.
  • React — library for building user interfaces based on components.
  • Next.js — framework that allows you to create React applications that you can render on the server.
  • Testing Library — very light-weight solution for testing without all the implementation details.
  • MongoDB — NoSQL database that stores data in JSON-like documents.
  • PostCSS — tool for transforming CSS with JavaScript-based plugins.
  • markdown-it — markdown parser to generate HTML.

🤝 Contributing

See CONTRIBUTING.md

📝 License

Distributed under the AGPL-3.0 license. See LICENSE for more information.

📢 Contact

donbarbos: donbarbos@proton.me