Skip to content

Commit

Permalink
platform: update README.md (#58)
Browse files Browse the repository at this point in the history
  • Loading branch information
adrianEffe authored Jul 24, 2024
2 parents 22a2ed5 + 9efaef0 commit 1737c56
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,35 @@

This is an example of an authentication service built using Rust, leveraging the `axum` web framework and `sqlx` for database interactions. The service uses RS256 (RSA Signature with SHA-256) for signing and verifying JSON Web Tokens (JWT).

## Getting Started

Follow these steps to set up and run the web application:

### Prerequisites

Ensure you have the following installed on your machine:
- [Docker](https://docs.docker.com/get-docker/)

### Steps to Run the Application

1. **Start Docker Daemon**

Make sure the Docker daemon is running on your machine. You can typically start it from your system tray or by running the following command:

```sh
sudo systemctl start docker
```

Alternatively, on macOS and Windows, you might need to open the Docker Desktop application.

2. **Initialize the Database**

Run the initialization script to start the necessary containers for Postgres and Redis:

```sh
./scripts/init_db.sh
```

## Features

- User registration, login, logout, refresh token
Expand Down

0 comments on commit 1737c56

Please sign in to comment.