Rust Web Kit

Basic setup for developing a web application, API or website in the 🦀 Rust language and the Actix-web framework.

Features

• Built with Actix-web for high-performance HTTP handling.
• SeaORM for seamless database integration.
• Handlebars template engine for safe and efficient HTML rendering.
• .env support for environment-specific configuration.
• Docker for containerization application.

Getting Started

Prerequisites

To work with SeaMS, ensure you have the following installed:

• Rust (latest stable version recommended)
• Docker (to quickly set up PostgreSQL and/or use Docker image)

Set Up PostgreSQL

You can run the following command to start a PostgreSQL instance using Docker:

docker run --name sea_ms_db -e POSTGRES_PASSWORD=secret_password -d postgres

Clone the Repository

Clone the project repository from GitHub:

git clone https://github.com/ZhukMax/rust-web-kit.git my-new-project

Setup Environment Variables

For production is better use GitHub Actions, GitLab CI or another Secrets sending method in Container.

For local development you can create a .env file in the root directory with the following variables:

HOST=0.0.0.0
PORT=8080

DATABASE_USER=<--user-->
DATABASE_PASSWORD=<--password-->
DATABASE_HOST=localhost
DATABASE_PORT=5432
DATABASE_NAME=<--name-->

DEV_MODE=false

Replace <--password--> with the password you set for your Docker PostgreSQL instance.

Install Dependencies

Run the following command to install the required dependencies:

make build

License

SeaMS is open-source software licensed under the MIT License.

Contribute

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub