https://github.com/pranahonk/roar-global-test
This repository contains the source code for a test project using Solid.js and Tiptap within Roar Global.
https://github.com/pranahonk/roar-global-test
Last synced: 2 months ago
JSON representation
This repository contains the source code for a test project using Solid.js and Tiptap within Roar Global.
- Host: GitHub
- URL: https://github.com/pranahonk/roar-global-test
- Owner: pranahonk
- Created: 2024-05-08T08:58:21.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-05-08T09:48:37.000Z (about 1 year ago)
- Last Synced: 2025-01-28T12:21:58.151Z (4 months ago)
- Language: TypeScript
- Size: 655 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Roar Global Test
This repository contains the source code for a test project using Solid.js and Tiptap within Roar Global.
## Demo Link
[Demo](https://roar-global.netlify.app/)
## Demo Image
## Project Setup
### Prerequisites:
- Node.js and npm (or yarn) installed on your system.
#### Installation:
```bash
git clone https://github.com/your-username/roar-global-test.git
```
#### Navigate to the project directory:
```bash
cd roar-global-test
```
#### Install dependencies:
```bash
npm install
```
# Scripts
The project includes various scripts to manage development, build, and testing processes:
- dev: Starts the development server using Vite.
- build: Creates an optimized production build.
- preview: Launches a preview server for the built application (useful for testing).
- lint: Runs ESLint to check code style and potential errors.
- lint:fix: Automatically fixes linting issues (if possible).
# Running the application:
Start the development server:
```bash
npm run dev
```
This will open the application in your default browser, usually at http://localhost:3000/.
# Dependencies
The project relies on several dependencies for functionality:
## Main Dependencies:
- Solid.js: A lightweight reactive JavaScript library.
- Tiptap: A rich text editor framework for building custom editing experiences.
## Solid-related dependencies:
- solid-tiptap: Provides integration between Solid.js and Tiptap.
- @solidjs/router: Routing library for Solid applications.
## Development dependencies:
- Vite: Build tool for modern web development.
- ESLint: Code linter for identifying style and quality issues.
- Tailwind CSS: Utility-first CSS framework.
- TypeScript: For type safety and improved development experience.
# Overview
This project serves as a starting point for exploring Solid.js and Tiptap within the Roar Global environment. The specific functionalities and features will depend on the implementation details within the codebase.