https://github.com/StudyResearchProjects/actix-rust-api-sample
🦀 A Web API written in Rust for learning purposes
https://github.com/StudyResearchProjects/actix-rust-api-sample
actix actix-web api docker rest rust sample web
Last synced: 6 months ago
JSON representation
🦀 A Web API written in Rust for learning purposes
- Host: GitHub
- URL: https://github.com/StudyResearchProjects/actix-rust-api-sample
- Owner: StudyResearchProjects
- Created: 2020-02-25T23:36:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-07-02T22:55:13.000Z (almost 6 years ago)
- Last Synced: 2025-10-10T19:10:35.368Z (6 months ago)
- Topics: actix, actix-web, api, docker, rest, rust, sample, web
- Language: Rust
- Homepage:
- Size: 150 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
rust-webapi
🦀 A Web API written in Rust for learning purposes
## Motivation
The main goal of this project is to learn about the *Rust* programming language
following a set of complete and rich in knowledge guides from Tore Pettersen in his
blog "[cloudmaker.dev](https://cloudmaker.dev/)".
## Requirements
- [Rust](https://rustup.rs/)
- [Docker](https://www.docker.com/)
## Getting Started
Some setup must be done before getting to run the application.
The following will walk you through the application environment setup.
When the setup is ready, run the application issuing the following command
from the project directory:
```sh
cargo run
```
### Running the Postgres Database, Redis and PgAdmin with docker
A `docker-compose.yml` file is available in the project directory
with the definition of the following services:
| Service | Image | Description |
| --------- | ----------------------- | --------------------------- |
| `database`| `postgres:9.6` | Postgres Database |
| `redis` | `redis:rc-buster` | Redis |
| `pgadmin` | `dpage/pgadmin4:latest` | A *Postgres* database admin |
A one line command is available to run as a *shell/bash* file in named `run-resources.sh`.
When running `run-resources.sh` the services in the table above will be the
only services running. The *Rust* server must be started manually
using `cargo run` from the project directory.
> The complete environment is available to run also. Issue `docker-compose up --build` from the project directory to build and run the complete set of services including the *Rust* server.
### Setup Diesel
Using `cargo install` command, install `diesel_cli` binary:
```sh
cargo install diesel_cli --no-default-features --features postgres
```
If theres no `diesel.toml` file in the project directory,
run `diesel setup` to generate such file.
Expected output:
```log
Creating migrations/2020-04-21-005225_create_user/up.sql
Creating migrations/2020-04-21-005225_create_user/down.sql
```
> To generate migrations, run `diesel migration generate `
> In order to run migrations and update database tables with the last schema run `diesel migration run`