https://github.com/gleam-lang/packages

📦 Search for Gleam packages
https://github.com/gleam-lang/packages

gleam postgresql webapp

Last synced: about 1 month ago
JSON representation

📦 Search for Gleam packages

• Host: GitHub
• URL: https://github.com/gleam-lang/packages
• Owner: gleam-lang
• License: apache-2.0
• Created: 2022-01-23T18:44:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-23T20:26:46.000Z (3 months ago)
• Last Synced: 2024-06-23T21:34:57.233Z (3 months ago)
• Topics: gleam, postgresql, webapp
• Language: Gleam
• Homepage: https://packages.gleam.run/
• Size: 247 KB
• Stars: 62
• Watchers: 5
• Forks: 12
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-gleam - gleam-lang/packages - The Gleam package index website. (Projects / Web applications)

README

        
# Gleam Packages

📦 Search for Gleam packages on [Hex](https://hex.pm).

A Gleam application using the [Wisp](https://gleam-wisp.github.io/wisp) web framework,

served with the [Mist](https://github.com/rawhat/mist) web server, using a

SQLite database.

The application is deployed on [Fly](https://fly.io) where

[LiteFS](https://github.com/superfly/litefs) is used to replicate the

SQLite database across all instances of the application.

## Environment variables

The application is configured with a series of environment variables.

- `HEX_API_KEY` - **Required**. A read-only API key for the Hex API. You can

  generate one via [the Hex dashboard](https://hex.pm/dashboard/keys).

- `DATABASE_PATH` - A path where the SQLite database will be stored. Defaults

  to `./database.sqlite`. In production this should be set to

  `$LITEFS_MOUNT_PATH/database.sqlite`.

- `LITEFS_PRIMARY_FILE` - If this environment variable is set then the

  application will only attempt to pull information from Hex and insert into the

  database if there is no file present at this path. When deployed to Fly this

  file is created by LiteFS for the node that has been elected leader, and the

  path will be `$LITEFS_MOUNT_PATH/.primary`.

## Local development

Install Gleam! See `./Dockerfile` for which version is used in production.

```shell

# Download a recent copy of the database

rm -f database.sqlite*

curl -o database.sqlite https://packages.gleam.run/packages.sqlite

gleam test        # Run the tests

gleam run server  # Run the server

```

The SQL query functions are generated from the `sql` directory. To regenerate

them run `gleam run -m codegen`.

## Deployment

```shell

# Deploy the application

fly deploy

```