Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/donbarbos/mdshare

📝 Best way to share your markdown files. (PaaS solution)
https://github.com/donbarbos/mdshare

knowledge-base link-shortener markdown markdown-it markdown-to-html markdown-viewer mongodb mongoose nextjs notes page-builder react share share-files sharing sharing-platform sharing-service short-url ssg viewer

Last synced: 2 months ago
JSON representation

📝 Best way to share your markdown files. (PaaS solution)

Host: GitHub
URL: https://github.com/donbarbos/mdshare
Owner: donBarbos
License: agpl-3.0
Created: 2022-10-27T10:11:38.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-05-04T12:11:56.000Z (9 months ago)
Last Synced: 2024-11-22T02:13:00.482Z (2 months ago)
Topics: knowledge-base, link-shortener, markdown, markdown-it, markdown-to-html, markdown-viewer, mongodb, mongoose, nextjs, notes, page-builder, react, share, share-files, sharing, sharing-platform, sharing-service, short-url, ssg, viewer
Language: TypeScript
Homepage: https://mdshare.vercel.app
Size: 1.67 MB
Stars: 8
Watchers: 0
Forks: 1
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

.mdShare

Best way to share your markdown files.

## 📄 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](#%EF%B8%8F-settings)

- Install dependens:

```bash
yarn install
```

- Build your application:

```bash
yarn build
```

- Start the Node.js server:

```bash
yarn start
```

- And you can check the site on [`localhost:3000`](http://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](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FdonBarbos%2Fmd-share)\
[![Deploy Mongo Cloud](https://img.shields.io/badge/MongoDB-4EA94B?style=for-the-badge&logo=mongodb&logoColor=white)](https://www.mongodb.com/atlas/database)

## ⚙️ 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`](./CONTRIBUTING.md)

## 📝 License

Distributed under the AGPL-3.0 license. See [`LICENSE`](./LICENSE) for more information.

## 📢 Contact

[donbarbos](https://github.com/donBarbos): [email protected]