Skip to content

Commit

Permalink
Fix README errors
Browse files Browse the repository at this point in the history
  • Loading branch information
SkyfallWasTaken committed Aug 28, 2024
1 parent c2557e6 commit cb47dc1
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,69 @@
# Vortex

A free, disposable email service from [Skyfall.](https://skyfall.dino.icu)
A free, disposable email service from [Skyfall.](https://skyfall.dev)

![e4494707-0aa6-4c93-aa64-25a0d0c0f7cc-image](https://github.com/SkyfallWasTaken/vortex.email/assets/55807755/96ed167b-5ace-4b25-ae4a-1b4e1053919f)

## Building

You will need:

- Rust
- Bun
- Node.js (to actually run the project)

Additionally, if you want to run the server, we recommend:

- Docker
- Caddy

### Building the SMTP server

Run:

```bash
cargo b --release
```

The server will be located at `/target/debug/vortex-server`.

### Building the frontend

Run:

```bash
cd frontend
bun run build
```

## Running Vortex

Ensure you've built everything first.

#### In development
### In development

In one terminal, run:

```bash
RUST_LOG=debug cargo run
```

Ensure you have permissions to bind to port 25.

In another, run:

```bash
cd frontend
bun dev
```

#### In production
### In production

##### Frontend
#### Frontend

Run it anywhere, e.g. Vercel. Ensure environment variables are set.

##### Backend
#### Backend

This assumes that you are using Docker and Caddy.

Expand Down

0 comments on commit cb47dc1

Please sign in to comment.