diff --git a/README.md b/README.md new file mode 100644 index 0000000..d4597ec --- /dev/null +++ b/README.md @@ -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?; +} +``` diff --git a/content/blog/0001-introducing-v1-2026-04-01.mdx b/content/blog/0001-introducing-v1-2026-04-01.mdx index 135ed8a..d2af089 100644 --- a/content/blog/0001-introducing-v1-2026-04-01.mdx +++ b/content/blog/0001-introducing-v1-2026-04-01.mdx @@ -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 diff --git a/content/blog/0002-building-a-task-tcpstream-pipe-with-apalis-postgres-2026-02-20.mdx b/content/blog/0002-building-a-task-tcpstream-pipe-with-apalis-postgres-2026-02-20.mdx index 7d0a9a3..b756afc 100644 --- a/content/blog/0002-building-a-task-tcpstream-pipe-with-apalis-postgres-2026-02-20.mdx +++ b/content/blog/0002-building-a-task-tcpstream-pipe-with-apalis-postgres-2026-02-20.mdx @@ -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: --- diff --git a/content/blog/0003-building-an-ai-travel-planner-with-dag-workflows-2025-03-25.mdx b/content/blog/0003-building-an-ai-travel-planner-with-dag-workflows-2025-03-25.mdx index a710c40..99063b7 100644 --- a/content/blog/0003-building-an-ai-travel-planner-with-dag-workflows-2025-03-25.mdx +++ b/content/blog/0003-building-an-ai-travel-planner-with-dag-workflows-2025-03-25.mdx @@ -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 diff --git a/public/images/geoff.jpg b/public/images/geoff.jpg new file mode 100644 index 0000000..c9ecc03 Binary files /dev/null and b/public/images/geoff.jpg differ