Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reformat #12

Merged
merged 1 commit into from
Oct 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 58 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,60 @@
# ksox-template

The KSOX Project

# KSOX-SERVER

[![GitHub Workflow Status Rust Build](https://github.com/visoftsolutions/ksox-server/actions/workflows/rust.yml/badge.svg)](https://github.com/visoftsolutions/ksox-server/actions/workflows/rust.yml)
![Version](https://img.shields.io/badge/version-0.1.0-blue)

## 🚀 Quick Start Guide

Embarking on your journey with the KSOX-SERVER workspace? Here's a streamlined guide:

### 1. **Cleanup**

Begin with a clean slate by removing residual files from any prior builds:

```sh
cargo clean
```

### 2. **Build**

Initialize your environment by installing all necessary dependencies:

```sh
cargo build
```

### 3. **Code Styling**

Ensure your code exudes clarity and consistency with our predefined standards:

```sh
cargo fmt
cargo sort -w
```

### 4. **Linting**

Maintain the integrity and quality of your code with our linting tools:

```sh
cargo clippy
```

### 5. **Unused Dependencies**

Regularly check for unused dependencies:

```sh
cargo +nightly udeps
```

## 🤝 Contributing

Encountered a hurdle or have a suggestion? Raise an issue or connect with our dedicated team. Your journey with KSOX-WEB is valued!

### 6. **Enviroment variables**

#### `./k8s/patches/dev/envs/config.env`:

Expand All @@ -22,4 +76,5 @@ SURREAL_PASS=surrealp4ssword
KSOX_SERVER_SURREALDB_URL = "http://surrealdb.test/"
KSOX_SERVER_REDIS_URL = "redis://redis.test/"
KSOX_SERVER_API_BIND = "0.0.0.0:8080"
```
KSOX_SERVER_JWT_SECRET = ""
```
1 change: 1 addition & 0 deletions core/blockchain/src/types.rs
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ pub struct EvmNetwork {
name: String,
rpc_url: Url,
}
#[allow(dead_code)]
impl EvmNetwork {
pub fn new(name: String, rpc_url: Url) -> Self {
Self { name, rpc_url }
Expand Down