Repository files navigation

Actix codebase containing real world examples (CRUD, auth, advanced patterns, etc) that adheres to theRealWorld spec and API.

❗ (2021/05/13) This codebase is currently unmaintained, and I am not interested in maintaining it. This relies on an old version of Actix -- developers who want to learn Actix should probably read the latest docs at theActix website.

This codebase was created to demonstrate a fully fledged fullstack application built withActix including CRUD operations, authentication, routing, pagination, and more. CORS, however, is not yet added.

This implementation is not reviewed. See theContributing section below.

For more information on how this works with other frontends, head over to theRealWorld repo.

This is an application written inRust that utilizesActix for developing the backend web service that powers the RealWorld application.

You can view a full list of crates being used inCargo.toml, but here are some of the main ones of note:

• Actix - a powerful Actor framework
• Chrono - a Date and Time library for Rust
• Failure - a system for creating and managing errors in Rust
• Futures - Zero-cost Futures in Rust
• jsonwebtoken - Create and parses JWT (JSON Web Tokens)
• libreauth - a collection of tools for user authentication
• Serde - a framework for serializing and deserializing Rust data structures efficiently and generically
• Uuid - Generate and parse UUIDs
• validator - Simple validation for Rust structs

• InstallRust
• InstallPostgreSQL if you don't have it already.
• Install theDiesel CLI with thepostgres feature enabled.
• Clone this repo to a folder on your computer.
• Copy (cp).env.example to.env within this directory, and change the environment variables accordingly to your system.
• Setup your database by runningdiesel database setup. Make sure it has completed successfully.
• Build this project withcargo build. You are welcome to compile with--release if you'd like.
• Run withcargo run.
• The API URL will be whatever theBIND_ADDRESS value is in.env with the/api path included e.g.https://127.0.0.1:3000/api. Set it as such in your REST client (Postman,Insomnia, etc.), import thepostman collection and start testing it out!

Feel free to take a look at the current issues in this repo for anything that currently needs to be worked on.

You are also welcome to open a new issue if you see something is missing or could be improved upon.