Skip to content

Commit 23952d9

Browse files
committed
Better documentation, license, and removed duplicate name in input.
1 parent 3536d03 commit 23952d9

File tree

3 files changed

+84
-39
lines changed

3 files changed

+84
-39
lines changed

LICENSE

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Copyright (c) 2025 LockScript
2+
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4+
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6+
7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 77 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,99 @@
1-
# [Lockscript Vault](https://vault.lockscript.dev)
1+
# [LockScript Vault](https://vault.lockscript.dev)
2+
An open-source secure credential vault for passwords, cards, notes, and PINs.
23

3-
LockScript Vault is an open-source secure vault for passwords, cards, notes, and pins.
4+
<p align="center">
5+
<img src="./public/images/lockscript.png" alt="LockScript" width="300" style="border-radius: 8px; box-shadow: 0 4px 8px rgba(0, 0, 0, 0.2);">
6+
</p>
47

5-
## Tech Stack
6-
- NextJS
7-
- TailwindCSS
8-
- Typescript
9-
- ShadCN
10-
- Prisma
11-
- Zod
8+
---
129

13-
## Getting Started
10+
## 🚀 Tech Stack
11+
12+
- **Framework**: Next.js
13+
- **Authentication**: Clerk
14+
- **Styling**: TailwindCSS
15+
- **Language**: TypeScript
16+
- **UI Components**: ShadCN
17+
- **ORM**: Prisma
18+
- **Validation**: Zod
19+
20+
---
21+
22+
## 🛠 Getting Started
23+
24+
### Clone the Repository
1425

15-
Clone the repository
1626
```bash
1727
git clone [email protected]:Lockscript/Lockscript-Vault
18-
```
19-
```bash
2028
cd Lockscript-Vault
2129
```
2230

23-
Repo is using yarn as a package manager.
31+
### Install Dependencies
2432

25-
[How To Install Yarn](https://classic.yarnpkg.com/lang/en/docs/install)
33+
This project uses yarn as the package manager.
2634

27-
Install dependencies
28-
```bash
29-
yarn install
30-
```
35+
[How to install Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable)
3136

32-
### Setup local database (if required)
37+
### Set Up Local Database (if required)
3338

34-
Start Docker container (requires [Docker](https://docs.docker.com/engine/install/))
39+
1. Start the Docker container (requires [Docker](https://docs.docker.com/engine/install/)):
40+
```bash
41+
docker compose -f ./local-database.yml up -d
42+
```
3543

36-
```bash
37-
docker compose -f ./local-database.yml up -d
38-
```
39-
Generate database client
44+
2. Generate the database client:
45+
```bash
46+
yarn generate
47+
```
4048

41-
```bash
42-
yarn run generate
43-
```
44-
```bash
45-
yarn run push
46-
```
49+
3. Push the Prisma schema to the database:
50+
```bash
51+
yarn push
52+
```
53+
54+
### Create a Clerk Project
55+
56+
1. Go to the [Clerk Dashboard](https://dashboard.clerk.com).
57+
2. Copy the `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` and `CLERK_SECRET_KEY`.
58+
3. Add them to your `.env` file.
59+
60+
### Start the Development Server
4761

48-
### Start the dev server
4962
```bash
50-
yarn run dev
63+
yarn dev
5164
```
5265

66+
---
67+
## 🤝 How to Contribute
68+
69+
We’re excited to have you contribute to LockScript Vault! Follow these steps to ensure your contributions are impactful and aligned with our project goals:
70+
71+
### 📝 Documentation
72+
- Provide clear and concise documentation for any new features, updates, or bug fixes.
73+
- Include code comments where necessary to explain non-obvious logic.
74+
75+
### 📦 Dependencies
76+
- If you introduce new dependencies, ensure they are necessary and well-documented.
77+
- Add a clear explanation of why the dependency was added in your pull request description.
78+
79+
### 🧪 Testing
80+
- Thoroughly test your changes before submission.
81+
- Write unit and integration tests for new features wherever applicable.
82+
- Ensure that all existing tests pass by running:
83+
```bash
84+
yarn build
85+
```
86+
---
87+
88+
## 📜 License
89+
90+
LockScript Vault is licensed under the [MIT License](./LICENSE), ensuring simplicity, flexibility, and freedom for contributors and users.
5391

54-
## How to contribute
92+
### What Does This Mean?
93+
- **Free to Use:** You are free to use, copy, modify, merge, publish, and distribute the code for personal, educational, or commercial purposes.
94+
- **Attribution Required:** Any use of the code must include the original copyright notice.
95+
- **No Warranty:** The software is provided "as is," without any warranty, ensuring no liability for the maintainers.
5596

56-
We accept contributions from the community, but you must follow some rules:
97+
The MIT License promotes open collaboration while giving you the freedom to innovate and build upon the project without restrictions.
5798

58-
1. Document your changes.
59-
2. Specifically state ANY new dependencies you have added.
60-
3. Test your changes.
99+
For more details, view the full license text in the [LICENSE](./LICENSE) file.

src/components/vault/dialogs/create-password-dialog.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,6 @@ export const CreatePasswordDialog = ({
158158
type="password"
159159
name="password"
160160
maxLength={128}
161-
name="password"
162161
/>
163162
<div
164163
className="pointer-events-none absolute inset-y-0 end-0 flex items-center justify-center pe-3 text-xs tabular-nums text-muted-foreground peer-disabled:opacity-50"

0 commit comments

Comments
 (0)