https://github.com/zhukmax/rust-web-kit

Basic setup for developing a web application, API or website in the 🦀 Rust language and the Actix-web framework.
https://github.com/zhukmax/rust-web-kit

actix-web rust rust-lang seaorm webapp

Last synced: over 1 year ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/zhukmax/rust-web-kit
• Owner: ZhukMax
• License: mit
• Created: 2025-02-22T23:47:07.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-03-02T06:08:52.000Z (over 1 year ago)
• Last Synced: 2025-03-02T07:19:24.573Z (over 1 year ago)
• Topics: actix-web, rust, rust-lang, seaorm, webapp
• Language: Rust
• Homepage:
• Size: 16.6 KB
• Stars: 14
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Rust Web Kit

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)

![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)

![GitHub Clones](https://img.shields.io/badge/dynamic/json?color=green&label=Clones&query=$.clones&url=https://raw.githubusercontent.com/ZhukMax/rust-web-kit/counter/.github/.clone_count)

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](https://www.rust-lang.org/tools/install) (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:

```bash

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

```

### Clone the Repository

Clone the project repository from GitHub:

```bash

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:

```env

HOST=0.0.0.0

PORT=8080

DATABASE_USER=dbuser

DATABASE_PASSWORD=secret_password

DATABASE_HOST=localhost

DATABASE_PORT=5432

DATABASE_NAME=my_db

DEV_MODE=fasle

```

Replace `secret_password` with the password you set for your Docker PostgreSQL instance.

### Install Dependencies

Run the following command to install the required dependencies:

```bash

make build

```

## License

SeaMS is open-source software licensed under the [MIT License](https://opensource.org/licenses/MIT).

## 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](https://kcd.im/pull-request)