Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhruv-kapoor-1202/serving-md
Simple Markdown Viewer
https://github.com/dhruv-kapoor-1202/serving-md
bun hono markdown react react-markdown tailwindcss
Last synced: 17 days ago
JSON representation
Simple Markdown Viewer
- Host: GitHub
- URL: https://github.com/dhruv-kapoor-1202/serving-md
- Owner: Dhruv-Kapoor-1202
- Created: 2024-09-08T10:48:58.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-09T08:35:05.000Z (4 months ago)
- Last Synced: 2024-12-18T17:13:07.157Z (17 days ago)
- Topics: bun, hono, markdown, react, react-markdown, tailwindcss
- Language: TypeScript
- Homepage: https://serving-md-production.up.railway.app/
- Size: 85.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# serving-md
## Installation and Running Instructions
### Dependencies Installation
To install the required dependencies for the project, execute the following command:
```bash
bun install
```### Running the Project
To start the development server, use:
```bash
bun run dev
```### Frontend-Specific Instructions
Navigate to the frontend directory:
```bash
cd .\frontend\
```To run the frontend development server, execute:
```bash
bun run dev
```### Building the Project
To build the project, which compiles TypeScript (TSX) and JavaScript (JSX) code into static HTML, CSS, and JavaScript files, use:
```bash
bun run build
```The build process will generate the output files in the `./frontend/dist/` directory. These static files are then served by the server at `http://localhost:3000`.