Actix Blog Save

A personal blog powered by rust-lang and actix-web

Project README

Build Status

About this project

There're two branches, the master uses actix-web 2.0, branch v1.0 uses actix-web 1.x, branch v0.7 uses actix-web 0.7.x.

BTW, I'm literally not that good at front-end.

Thanks to these resources

  • Front-End

  1. I abandoned bootstrap to build the front-end, written it from zero, but still kind of ugly.
  2. Showdown for rendering markdown.
  3. Jquery
  4. Js.cookie(for cookies handling)
  • Back-End

  1. The blazingly fast asynchronous web framework based on Rust: actix-web
  2. Database ORM based on Rust as well: diesel
  3. HTML template engine(rust based): tera

Requirements

  1. Better use stable rust. (2018 edition, though travis compiles the project on nightly and beta one)
  2. Postgresql. (11.x, I didn't try on 9.x or 10.x)

Deployment(rust, postgresql and diesel_cli already installed)

  1. Download the repo
git clone https://github.com/Dengjianping/Actix-Blog.git
  1. Create a database in postgresql, remember the name for next operation.
  2. Modify the .env file, add following configuration.
DATABASE_URL=postgres://[your_name]:[passowrd]@localhost/[database_name]
  1. Install diesel_cli with the following command.
cargo install diesel_cli --no-default-features --features "postgres"
  1. Create these related tables, make sure 4 tables created and named comments/contacts/posts/users in database.
cd actix_blog
# migration, 
diesel migration setup
  1. Configure the project. There's a actix_blog.toml file in root folder, give the actual values to it.
  2. Build the project.
cargo run --release

How to tun test

  1. Modify database url for testing in file .env.
TEST_DATABASE_URL=postgres://[your_name]:[passowrd]@localhost/[database_name]
  1. Migration. The following command will generate all tables the project needs.
diesel --database-url postgres://[your_name]:[passowrd]@localhost/[database_name] migration run
  1. Run test.
cargo test

Tips: All test cases are under src/test.

Glance

main page admin page admin page

Features

  • Sign-in/out
  • Password resetting
  • Register
  • Comment system(ajax)
  • Use likes(ajax)
  • Category
  • Search
  • Basic admin privileges
  • Markdown supporting.
  • HTTP2(s) Support(not default)
    • If you really want to experience http2, use the example ssl keys or follow this English or 中文 to create certifications, put the generated keys to folder "ssl_keys", rename both keys with the same name as the example's. And Compile the project with this following command.
    cargo run --release --features "http2"
    
    • Visit the site.
    https://your_address:port_num/
    

Future

  • Redis.
  • Dockerfile.
  • OAuth. Allow 3rd-party user log-in, like webchat/github/google/apple... .
  • The webUI may be rewritten by webassembly(I did some research, several webassembly frameworks is available now
  • ...
Open Source Agenda is not affiliated with "Actix Blog" Project. README Source: Dengjianping/Actix-Blog
Stars
45
Open Issues
13
Last Commit
1 year ago

Open Source Agenda Badge

Open Source Agenda Rating