Skip to content

Commit 1109d5b

Browse files
committed
- Fixed README syntax errors for better readability
- Added frontend screenshot for preview - Updated backend package versions to latest releases
1 parent 3563f46 commit 1109d5b

11 files changed

Lines changed: 34 additions & 2897 deletions

File tree

.vscode/settings.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

Cargo.toml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,16 @@
11
[package]
22
name = "Password_Manager"
3-
version = "2.0.0"
3+
version = "2.5.0"
44
edition = "2021"
55

66
[dependencies]
7-
clap = { version = "4.0", features = ["derive"] }
8-
serde = { version = "1.0", features = ["derive"] }
9-
serde_json = "1.0"
10-
aes-gcm = "0.10"
11-
rpassword = "7.0"
12-
argon2 = "0.5"
7+
actix-cors = "0.7.0"
8+
actix-web = "4.9.0"
9+
aes-gcm = "0.10.3"
10+
argon2 = "0.5.3"
11+
clap = { version = "4.5.28", features = ["derive"] }
12+
rpassword = "7.3.1"
1313
rusqlite = { version = "0.31", features = ["bundled"] }
14+
serde = { version = "1.0.217", features = ["derive"] }
1415
thiserror = "2.0.11"
1516
zeroize = "1.8.1"
16-
actix-web = "4.9.0"
17-
actix-cors = "0.7.0"
18-
hex = "0.4.3"

README.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,23 @@ This project consists of a frontend (Next.js) and a backend (Rust). Follow the i
2727
#### Installation and Running
2828

2929
```bash
30-
git clone [https://github.com/Amitminer/PasswordManager-Rust.git](https://github.com/Amitminer/PasswordManager-Rust.git)
30+
git clone https://github.com/Amitminer/PasswordManager-Rust.git
3131
cd PasswordManager-Rust/website
3232
npm install # or yarn install
3333
npm run dev # or yarn dev
3434
```
3535

3636
This will start the development server. The frontend will typically be available at `http://localhost:3000`.
3737

38+
#### Frontend Screenshots
39+
40+
Take a look at some screenshots of the frontend interface:
41+
42+
- ![Homepage](screenshots/homepage.png)
43+
- ![Add Password](screenshots/add_passoword.png)
44+
- ![List Passwords](screenshots/list_passwords.png)
45+
- ![New Master Key](screenshots/new_master_key.png)
46+
3847
### 2️⃣ Backend Setup (Rust)
3948

4049
#### Requirements
@@ -51,7 +60,7 @@ cargo build --release # Build the release version for optimized performance
5160
cargo run -- --api # Run the backend with the API enabled
5261

5362
# OR run the compiled binary directly (after building):
54-
./target/release/password-manager --api
63+
./target/release/Password_Manager --api
5564
```
5665

5766
The API will be available at `http://127.0.0.1:8080/api` (or `http://localhost:8080/api`).
@@ -106,7 +115,6 @@ if __name__ == "__main__":
106115
print(remove_password("example.com"))
107116
print("\n⚠️ Clearing All Data...")
108117
print(clear_all_data())
109-
110118
```
111119

112120
**Important:** The Python example assumes the API is running. Make sure you have started the backend as described above. The API endpoints and expected JSON request/response formats should be documented clearly (consider using OpenAPI/Swagger).

package.json

Lines changed: 0 additions & 5 deletions
This file was deleted.

screenshots/add_passoword.png

56.3 KB
Loading

screenshots/homepage.png

38.5 KB
Loading

screenshots/list_passwords.png

42.2 KB
Loading

screenshots/new_master_key.png

47.3 KB
Loading

website/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,15 @@ This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-
22

33
## Getting Started
44

5-
First, run the development server:
5+
This project serves as an example for demonstrating our Password Manager Rust API.
6+
7+
First, install the necessary dependencies:
8+
9+
```bash
10+
npm install
11+
```
12+
13+
Then, run the development server:
614

715
```bash
816
npm run dev
@@ -14,6 +22,12 @@ pnpm dev
1422
bun dev
1523
```
1624

25+
To build and deploy the project, use:
26+
27+
```bash
28+
npm run build
29+
```
30+
1731
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
1832

1933
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.

0 commit comments

Comments
 (0)