Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Apalis Website and Documentation

## Website

View the deployed project: [Website](https://apalis.dev)


## Local Installation

This project requires `cargo` and `node.js` to be installed.

Clone the project:

git clone git@github.com:apalis-dev/website.git

Install dependencies:

yarn

Run dev server:

yarn dev


## Development

This project includes a way to build code examples to ensure that they can compile eg:

\```rust name="push" mode="inline"
let task = Email {
recipient: "main@example.com".to_string(),
message: "Welcome to our new service".to_string()
};
storage.push(task).await?;
\```


\```rust fileName="main.rs" mode="compile"
use apalis::prelude::*;

#[tokio::main]
async fn main() -> Result<(), BoxDynError> {
let mut storage = MemoryStorage::new();

// [!code inline:push]
}
\```

This would generate:


```rust fileName="main.rs" mode="compile"
use apalis::prelude::*;

#[tokio::main]
async fn main() -> Result<(), BoxDynError> {
let mut storage = MemoryStorage::new();

let task = Email {
recipient: "main@example.com".to_string(),
message: "Welcome to our new service".to_string()
};
storage.push(task).await?;
}
```
2 changes: 1 addition & 1 deletion content/blog/0001-introducing-v1-2026-04-01.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date: 2026-04-01
authors:
- name: Njuguna Mureithi
description: Core Maintainer
avatar: https://pbs.twimg.com/profile_images/1897875194124931072/NJGmldme_400x400.jpg
avatar: /images/geoff.jpg
twitter: https://twitter.com/mureithi_me
relatedPosts:
- building-a-task-tcpstream-pipe-with-apalis-postgres-2026-02-20
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date: 2026-02-20
authors:
- name: Njuguna Mureithi
description: Core Maintainer
avatar: https://pbs.twimg.com/profile_images/1897875194124931072/NJGmldme_400x400.jpg
avatar: /images/geoff.jpg
twitter: https://twitter.com/mureithi_me
relatedPosts:
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ date: 2026-03-25
authors:
- name: Njuguna Mureithi
description: Core Maintainer
avatar: https://pbs.twimg.com/profile_images/1897875194124931072/NJGmldme_400x400.jpg
avatar: /images/geoff.jpg
twitter: https://twitter.com/mureithi_me
relatedPosts:
- building-a-task-tcpstream-pipe-with-apalis-postgres-2026-02-20
Expand Down
Binary file added public/images/geoff.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading