Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jefer94/lit-ssr-utils
Lit utils to implement SSR to projects that do not use Javascript.
https://github.com/jefer94/lit-ssr-utils
Last synced: 27 days ago
JSON representation
Lit utils to implement SSR to projects that do not use Javascript.
- Host: GitHub
- URL: https://github.com/jefer94/lit-ssr-utils
- Owner: jefer94
- License: lgpl-3.0
- Created: 2024-01-07T01:57:09.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-01-27T21:27:58.000Z (10 months ago)
- Last Synced: 2024-10-12T10:34:27.215Z (about 1 month ago)
- Language: TypeScript
- Homepage:
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Lit SSR API
Lit utils to implement SSR to projects that do not use Javascript.
## Installation
To get started with this project, follow these steps:
1. Clone the repository.
2. Install dependencies by running: `bun install -D`.
3. Start the project by running: `npm start`.
## Usage
You can do an HTTP call, but this does not have authentication yet, you must adapt this code to your case, if you use Google Cloud Functions or something like that you would need to implement an authentication.
```HTTP
POST / HTTP/1.1
Content-Type: application/json
{
"html": ""
"dependencies": [{ "code": "...", "ext": "ts" }]
}
```
Don't forget to import [`@lit-labs/ssr-client/lit-element-hydrate-support.js`](https://lit.dev/docs/ssr/client-usage/#[email protected]) in your HTML to add hydrate support (issue [#4472](https://github.com/lit/lit/issues/4472)).
### Using adapters
You should implement our adapter with:
```ts
import start from "lit-ssr-utils/adapters/elysia";
start();
```
### Out adapters
| Adapter | Stability | Ready to use | Additional dependency |
| ---------------- | --------- | ------------ | --------------------- |
| Elysia | ✅ | 🤔💭 | elysia |
| unix-socket/bun | ❌ | ❌ | |
| unix-socket/Node | ❌ | ❌ | |
### Implementing your favorite framework
You should implement it using:
```ts
import { rpc } from "lit-ssr-utils";
```
Or.
```ts
import { api } from "lit-ssr-utils";
```
I suggest that you check our `examples` folder.
## Contributing
Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:
1. Fork the repository.
2. Create a new branch (`git checkout -b feature/new-feature`).
3. Make your changes.
4. Commit your changes (`git commit -am 'Add new feature'`).
5. Push to the branch (`git push origin feature/new-feature`).
6. Create a pull request.
## License
This project is licensed under the [LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html).
## Contact
If you have any questions, feel free to open an issue.