rust-web-kit

KO | EN

gitlite — search

#react #ai #llm #go #android #rust #linux #docker #windows #awesome #pytorch #ios #openai #open-source

(★ 25)

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

rust-web-kit Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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)

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=<--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:

```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)

rust-web-kit

rust-web-kit Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

rust-web-kit

rust-web-kit Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README