https://github.com/hexpm/hexdocs-search
https://github.com/hexpm/hexdocs-search
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/hexpm/hexdocs-search
- Owner: hexpm
- Created: 2025-01-30T11:41:22.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-11-24T17:29:52.000Z (7 months ago)
- Last Synced: 2026-01-29T20:20:48.880Z (4 months ago)
- Language: Gleam
- Size: 259 KB
- Stars: 26
- Watchers: 4
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Hexdocs Frontend
Hexdocs Frontend is using [Lustre](https://lustre.build), a single-page
application running in client, interacting with the backend through asynchronous
HTTP requests.
Running a Lustre application can easily be achieved using [Gleam](https://gleam.run/)
and the [Lustre Dev Tools](https://hexdocs.pm/lustre_dev_tools/).
Lustre Dev Tools is a companion package to Lustre, in charge of compiling,
bundling, and running the application in browser.
## Launching the dev server
With Gleam installed on your path, you can directly start the development server
using Lustre Dev Tools.
```sh
gleam run -m lustre/dev start
```
The application will be running at `http://localhost:1234`.
## Building the application
Building the application can be done with the Lustre Dev Tools too.
```sh
gleam run -m lustre/dev build
```
Then you can deploy the contents of the `dist/` folder.
## Deployment
```
$ git pull origin main
$ git push origin main:prod
```
## Quick reminder of the structure
- All source files reside in `src` folder.
- There's no `index.html` in the sources, as the file is automatically
generated by Lustre Dev Tools with the configuration written in `gleam.toml`.
- `hexdocs.css` is the entrypoint for CSS for the application. Tailwind is
setup in that file.