README.md 2.2 KB

Akane

The Nim asynchronous web framework.

Open Source Love Nim language-plastic License test

Latest version - 0.1.7

Stable version - 0.1.7

Install

  • git: nimble install https://github.com/Ethosa/akane.git
  • nimble: nimble install akane

Features

  • Pages with URL handling methods: equals, startswith, endswith, regex,notfound;
  • templates folder;
  • Only the standard library used;
  • YML-like pages syntax;
  • Debug mode;
  • Password hashing;
  • Working with cookies;
  • Simple usage:

    import akane
    
    proc main =  # for gcsafe
      var server = newServer()  # by default launches on http://localhost:5000
    
      server.pages:
        equals("/"):  # when url is "http://...localhost:5000/"
          # You also can write "/" instead of equals("/")
          # type of `request` is a Request.
          await request.answer("Hello, world!")  # utf-8 encoded message.
    
        equals("/getme", HttpGet):
          await request.answer("You can see it only on GET method! :)")
    
      server.start()
    main()
    

    Debug mode

    For enable debug mode, please, compile with -d:debug or --define:debug.

    Tools

    For enable other tools like password checking, please, compile with -d:tools or --define:tools.

    FAQ

    Q: Where can I learn this?
    A: You can see wiki page

    Q: Where can I find the docs?
    A: You can see docs page

    Q: How can I help to develop this project?
    A: You can put a :star: :3

    Copyright 2020 Ethosa