https://github.com/vitorwlima/cool-keeper
⭐ Password manager of the future.
https://github.com/vitorwlima/cool-keeper
nextauth nextjs planetscale prisma tailwindcss trpc typescript
Last synced: 10 months ago
JSON representation
⭐ Password manager of the future.
- Host: GitHub
- URL: https://github.com/vitorwlima/cool-keeper
- Owner: vitorwlima
- Created: 2022-06-11T21:38:43.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-06-30T00:58:46.000Z (almost 4 years ago)
- Last Synced: 2025-08-31T04:27:39.181Z (10 months ago)
- Topics: nextauth, nextjs, planetscale, prisma, tailwindcss, trpc, typescript
- Language: TypeScript
- Homepage: https://cool-keeper.vercel.app
- Size: 764 KB
- Stars: 7
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Cool Keeper
## :dart: About ##
Cool keeper is the modern password manager we have been looking for. Built using the latest technologies from the web development world, it's goal is to provide the users a safe place to store their passwords with a great UX and beautiful UI (work in progress). The idea is to achieve this by building a highly interactive open source environment where people can contribute adding features and fixing bugs.
## :rocket: Technologies ##
The following tools were used in this project:
- [Next.js](https://nextjs.org/)
- [TypeScript](https://www.typescriptlang.org/)
- [TailwindCSS](https://tailwindcss.com/)
- [Prisma](https://www.prisma.io/)
- [tRPC](https://trpc.io/)
- [Planetscale](https://planetscale.com/)
- [NextAuth](https://next-auth.js.org/)
## :white_check_mark: Requirements ##
Before starting :checkered_flag:, you need to have [Git](https://git-scm.com), [Node](https://nodejs.org/en/) and [PnpM](https://pnpm.io/) installed.
## :checkered_flag: Contributing ##
Clone the project:
```bash
# Clone this project
$ git clone https://github.com/vitorwlima/cool-keeper
# Access
$ cd cool-keeper
# Install dependencies
$ pnpm install
# Run the project
$ pnpm run dev
# The server will initialize in the
```
Setup your .env file:
```typescript
DATABASE_URL=your_planetscale_db_url
PASSWORD_HASH=random_string
```
> The DB section is optional, and you can make it run locally while developing if that is better for you.
After that, you are ready to start working on the project. Feel free to pick any open issues or open new ones that you feel are important. The flow is standard: you need to create a separate branch and then create a pull request into `main` branch. Also, when commiting it is recommended to use [this convention](https://dev.to/i5han3/git-commit-message-convention-that-you-can-follow-1709).
## :memo: License ##
This project is under license from MIT. For more details, see the [LICENSE](LICENSE.md) file.
Made with :heart: by Vitor Lima