Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
kevenleone committed Jun 12, 2023
1 parent 3e06ddc commit 91ebaf4
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 35 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@
## Description

Save and organize your favorites markdown files in a single storage and share with friends.

The application was designed to be Client Side (Vite) and leverage Supabase for Auth and Storage, still considering to move to SSR approach.
Save and organize your favorites markdown files in a single storage and share with friends and team.

## :zap: Installation and Instructions

Expand All @@ -16,16 +14,16 @@ The application was designed to be Client Side (Vite) and leverage Supabase for

- apps/mdreader
- Main application using Vite
- packages/md
- packages/markdown
- Component Library responsible for rendering Articles `(.md files)`
- Renderer made with rehype and remark libraries.
- packages/ui
- packages/interface
- Reusable Components provided by [shadcn/ui](https://github.com/shadcn/ui).

```
apps/mdreader
packages/md
packages/ui
packages/markdown
packages/interface
```

## Motivation
Expand Down
40 changes: 12 additions & 28 deletions apps/mdreader/README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,18 @@
# Welcome to Remix!
# :bookmark: MD Reader - Web Application

- [Remix Docs](https://remix.run/docs)
### :blue_book: Description

## Deployment
MD Reader is a web application built using React, Remix, and Supabase. It incorporates the following technologies:

After having run the `create-remix` command and selected "Vercel" as a deployment target, you only need to [import your Git repository](https://vercel.com/new) into Vercel, and it will be deployed.
* **Blurhash** -> Provides a compact representation of a placeholder for an image.
* **BoringAvatars** -> Offers an avatar generator playground.
* **React-Hook-Form** -> Simplifies React forms validation.
* **SWR** -> Provides React Hooks for data fetching.
* **Tailwind** -> Tailwind CSS is a utility-first CSS.
* **Zod** -> Facilitates schema declaration and validation.

If you'd like to avoid using a Git repository, you can also deploy the directory by running [Vercel CLI](https://vercel.com/cli):
### :exclamation: Purpose:

```sh
npm i -g vercel
vercel
```
MD Reader aims to enhance user experience by enabling them to save, organize, and share valuable content from GitHub and knowledge bases. It serves as a convenient repository for links that users may find interesting and wish to share with their team.

It is generally recommended to use a Git repository, because future commits will then automatically be deployed by Vercel, through its [Git Integration](https://vercel.com/docs/concepts/git).

## Development

To run your Remix app locally, make sure your project's local dependencies are installed:

```sh
npm install
```

Afterwards, start the Remix development server like so:

```sh
npm run dev
```

Open up [http://localhost:3000](http://localhost:3000) and you should be ready to go!

If you're used to using the `vercel dev` command provided by [Vercel CLI](https://vercel.com/cli) instead, you can also use that, but it's not needed.
I chose Remix for its route system, which is similar to react-router-dom. Leveraging my experience with react-router-dom, I found Remix to be an easier and more streamlined option for transitioning from client-side to server-side rendering.

1 comment on commit 91ebaf4

@vercel
Copy link

@vercel vercel bot commented on 91ebaf4 Jun 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

mdreader – ./

mdreader.vercel.app
mdreader-kevenleone.vercel.app
mdreader-git-main-kevenleone.vercel.app

Please sign in to comment.