Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://planety.github.io/prologue/

Powerful and flexible web framework written in Nim
https://planety.github.io/prologue/

async async-web-applications full-stack hacktoberfest http-framework jester nim nimlang prologue prologue-framework web web-development webapp-framework webdev webframework

Last synced: about 1 month ago
JSON representation

Powerful and flexible web framework written in Nim

Host: GitHub
URL: https://planety.github.io/prologue/
Owner: planety
License: apache-2.0
Created: 2020-01-11T03:36:15.000Z (over 4 years ago)
Default Branch: devel
Last Pushed: 2024-01-23T04:40:07.000Z (8 months ago)
Last Synced: 2024-04-14T05:31:10.751Z (5 months ago)
Topics: async, async-web-applications, full-stack, hacktoberfest, http-framework, jester, nim, nimlang, prologue, prologue-framework, web, web-development, webapp-framework, webdev, webframework
Language: Nim
Homepage: https://planety.github.io/prologue
Size: 5.59 MB
Stars: 1,200
Watchers: 27
Forks: 46
Open Issues: 30
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        ![Build Status](https://github.com/planety/prologue/workflows/Test%20Prologue/badge.svg)

![License: Apache-2.0](https://img.shields.io/github/license/planety/prologue)

[![Version](https://img.shields.io/github/v/release/planety/prologue?include_prereleases)](https://github.com/planety/prologue/releases)

[![buy me a coffee](https://img.shields.io/badge/donate-buy%20me%20a%20coffee-orange.svg)](https://github.com/planety/prologue#donations)

[![Discord](https://img.shields.io/discord/718010516034945045?label=Discord&logo=discord&logoColor=white)](https://discord.gg/e2dB4WT)

# Prologue

What's past is prologue.

## Purpose

`Prologue` is a powerful and flexible web framework written in Nim.

It is ideal for building elegant and high performance web services.

**Reduce magic. Reduce surprise.**

## Documentation

  

    Documentation

    Index Page

  

  

    Core API

    Index Page

    Search Page

  

  

    Full API

    Index Page

    Search Page

  

Welcome to write your own experience with Prologue at our [wiki](https://github.com/planety/prologue/wiki).

## Features

- Core

  - [x] Configure and Settings

  - [x] Context

  - [x] Param and Query Data

  - [x] Form Data

  - [x] Static Files

  - [x] Middleware

  - [x] Powerful Routing System(based on [nest](https://github.com/kedean/nest))

  - [x] Cookie

  - [x] Startup and Shutdown Events

  - [x] URL Building

  - [x] Error Handler

- Plugin

  - [x] I18n

  - [x] Basic Authentication

  - [x] Minimal OpenAPI support

  - [x] Websocket support

  - [x] Mocking test

  - [x] CORS Response

  - [x] Data Validation

  - [x] Session

  - [x] Cache

  - [x] Signing

  - [x] Command line tools

  - [x] Cross-Site Request Forgery

  - [x] Clickjacking Protection

## Installation

First you should install [Nim](https://nim-lang.org/) language which is an elegant and high performance language. Follow the [instructions](https://nim-lang.org/install.html) and set environment variables correctly.

Then you can use `nimble` command to install `prologue`.

```bash

nimble install prologue

```

## Usages

### Hello World

```nim

import prologue

proc hello*(ctx: Context) {.async.} =

  resp "
Hello, Prologue!
"

let app = newApp()

app.get("/", hello)

app.run()

```

Run **app.nim** ( `nim c -r app.nim` ). Now the server is running at `localhost:8080`.

### More examples

- [HelloWorld](https://github.com/planety/prologue/tree/devel/examples/helloworld)

- [ToDoList](https://github.com/planety/prologue/tree/devel/examples/todolist)

- [ToDoApp](https://github.com/planety/prologue/tree/devel/examples/todoapp)

- [Blog](https://github.com/planety/prologue/tree/devel/examples/blog)

- [Additional examples repository](https://github.com/planety/prologue-examples)

### Extensions

If you need more extensions, you can refer to [awesome prologue](https://github.com/planety/awesome-prologue) and [awesome nim](https://github.com/ringabout/awesome-nim#web).

## Donations

Thanks for supporting me!

https://github.com/sponsors/planety

## Stars

[![Stargazers over time](https://starchart.cc/planety/prologue.svg)](https://starchart.cc/planety/prologue)