# rcms

**Repository Path**: nur/rcms

## Basic Information

- **Project Name**: rcms
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-09-03
- **Last Updated**: 2021-09-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Radical

## Index

- [Project](#project-description)
- [How to Install](https://github.com/Rust-CMS/tooling)
- [Project State](#project-state)
- [Testing](#note-on-testing)
- [Dev Environment Setup](#dev-environment-setup)
- [Environment Variables](#environment-variables)
- [404 Pages](#notes-on-404-pages)
- [Similar Repositories](#repositories-like-this)

## Project Description

Radical is a CMS heavily inspired by [Processwire](https://processwire.com/). This is not a markdown site generator like other CMSs. If you would like something of that nature, see [here](#repositories-like-this).

## Server Installation

If you have docker, all you need to do is run [this](https://github.com/Rust-CMS/tooling) docker-compose.

Sub $2/month GCP Cloud Run tutorial coming soon!

## Project State

Version: v0.1.2

|             | Ready |
| ----------- | ----------- |
| Backend | ✅ |
| Frontend | ✅ |
| Production | - |

## Note on testing

Whenever you run the tests, it is best to have a clean database.

You **MUST** run it using this command (since mocking for Diesel isn't mature yet):

`cargo test -- --test-thread=1`

## Dev Environment Setup

Required items:
* Rustc
* MySQL (8.0+ preferred)
* Diesel CLI (`cargo install diesel_cli --no-default-features --features mysql`)

1. Clone this repository.

`git clone git@github.com:SpBills/rust-cms.git`

Then, enter the repository.

`cd rust-cms`

2. Create a MySQL database.

Log in to your MySQL server, and `CREATE DATABASE rustcms;`

3. Add a user to this database and give them privileges.

Change anything labelled `rustcms`, as it is a placeholder. Since this is a dev environment, you shouldn't have to worry about security too much though.

`CREATE USER 'rustcms'@'%' IDENTIFIED BY 'rustcms';`

Giving them privileges:

`GRANT ALL PRIVILEGES ON rustcms.* TO 'rustcms'@'%';`

`FLUSH PRIVILEGES`

4. Setup environment variables.

Since this is a development environment, we won't be explicitly setting these on the system. Instead, we'll store them in a file named `.env` in the root of this project.

First, create a file named `.env`.

Next, put in your MySQL connection string. Extensive examples for a full .env can be seen [here](#environment-variables).

The MySQL connection string is not used for the program connecting to the database, but rather for running the migrations. This is usually not required to be done manually.

`DATABASE_URL=mysql://rustcms:rustcms@localhost:3306/rustcms`

5. Run Diesel migrations.

First, install Diesel.

`cargo install diesel_cli --no-default-features --features mysql`

Next, run the migrations.

`diesel migration run`

## Environment Variables
Most all environment setup will be handled by an installer GUI in the future.

```yaml
app_mysql_username=String
app_mysql_password=String
app_mysql_database=String
app_bind_address=String
app_bind_port=Number
# Max request per IP per minute. Recommended 100 for 512mb 1vCPU
app_max_req=Number

app_mysql_url?=String
app_mysql_port?=Number

# OR for places like GCP Cloud Run. Do not mix, it will not work.
# Note the lack of the APP_ prefix.
MYSQL_UNIX_PORT?=String

```

## Notes on 404 Pages

404s are handled (currently) by creating a file called `404.html.` It will automatically be added as your 404 page.

## Repositories Like This

Markdown static site generators:

(Data retrieved from [here](https://www.arewewebyet.org/topics/cms/))

https://github.com/getzola/zola

https://github.com/cobalt-org/cobalt.rs

https://github.com/rust-lang/mdBook