|
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. |
2 | 3 |
|
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> |
4 | 7 |
|
5 |
| -## Tech Stack |
6 |
| -- NextJS |
7 |
| -- TailwindCSS |
8 |
| -- Typescript |
9 |
| -- ShadCN |
10 |
| -- Prisma |
11 |
| -- Zod |
| 8 | +--- |
12 | 9 |
|
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 |
14 | 25 |
|
15 |
| -Clone the repository |
16 | 26 | ```bash
|
17 | 27 | git clone [email protected]:Lockscript/Lockscript-Vault
|
18 |
| -``` |
19 |
| -```bash |
20 | 28 | cd Lockscript-Vault
|
21 | 29 | ```
|
22 | 30 |
|
23 |
| -Repo is using yarn as a package manager. |
| 31 | +### Install Dependencies |
24 | 32 |
|
25 |
| -[How To Install Yarn](https://classic.yarnpkg.com/lang/en/docs/install) |
| 33 | +This project uses yarn as the package manager. |
26 | 34 |
|
27 |
| -Install dependencies |
28 |
| -```bash |
29 |
| -yarn install |
30 |
| -``` |
| 35 | +[How to install Yarn](https://classic.yarnpkg.com/lang/en/docs/install/#windows-stable) |
31 | 36 |
|
32 |
| -### Setup local database (if required) |
| 37 | +### Set Up Local Database (if required) |
33 | 38 |
|
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 | + ``` |
35 | 43 |
|
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 | + ``` |
40 | 48 |
|
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 |
47 | 61 |
|
48 |
| -### Start the dev server |
49 | 62 | ```bash
|
50 |
| -yarn run dev |
| 63 | +yarn dev |
51 | 64 | ```
|
52 | 65 |
|
| 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. |
53 | 91 |
|
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. |
55 | 96 |
|
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. |
57 | 98 |
|
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. |
0 commit comments