https://github.com/adarshaacharya/passman
Password manager that you don't need.
https://github.com/adarshaacharya/passman
hacktoberfest
Last synced: 6 months ago
JSON representation
Password manager that you don't need.
- Host: GitHub
- URL: https://github.com/adarshaacharya/passman
- Owner: adarshaacharya
- License: mit
- Created: 2022-05-15T10:07:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-10T05:04:04.000Z (about 2 years ago)
- Last Synced: 2025-03-27T21:38:38.835Z (7 months ago)
- Topics: hacktoberfest
- Language: TypeScript
- Homepage: https://passmanager.vercel.app/
- Size: 520 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
Cloud based password manager.
Login using your auth povider, create vault for personal and business purpose and enjoy seamless experience.
View Demo
·
Report Bug
·
Request Feature
## Tech Stack
- ⚡️ Next.js 12
- ⚛️ React 18
- ⛑ TypeScript
- 📙 Database : PostgreSQL
- 🚓 ORM : Prisma
- 💄 Component Library : Chakra UI
- 🔑 Hashing : AES256, Scrypt
- 📦 Containerization : Docker
### Requirements
- Node.js >= 12.22.0
- Yarn 1 (Classic)
### Local Development
To start the project locally, run:
```bash
yarn dev
```
Open `http://localhost:3000` with your browser to see the result.
### Env variables setup
- create new file .env in root folder
- open [.env.example](./.env.example)
- copy the content and paste it to the .env
Fillup `.env` variables with valid keys for database.
### Authentication
You might have seen env variables for authentication in `.env` file.
[NextAuth.js](https://next-auth.js.org/) has been used for authentication, and Github has been used as provider. [Please read this docs](https://next-auth.js.org/providers/github) setting up keys is fairly simple.
### Database setup
This project uses POSTGRESQL db so you need to have POSTGRES installed in you machine or you can use docker. Create database named `passman`.
To configure your database to use the new schema (i.e. create tables and columns) use the prisma migrate command:
```bash
npx prisma migrate dev
```
### Docker Setup
The database has support for Docker. So if you want to run the database in a container, you need to [install docker and docker compose](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-compose-on-ubuntu-20-04)
Open terminal in root directory of this project and run docker-compose:
```bash
docker-compose up -d
```
Now, you have postgres port running successfully on PORT `5433`. Check using `docker ps -a`.
Check [docker-compose.yml](./docker-compose.yml) for full configuation.
### Scripts
- `yarn dev` — Starts the application in development mode at `http://localhost:3000`.
- `yarn build` — Creates an optimized production build of your application.
- `yarn start` — Starts the application in production mode.
- `yarn type-check` — Validate code using TypeScript compiler.
- `yarn lint` — Runs ESLint for all files in the `src` directory.
- `yarn format` — Runs Prettier for all files in the `src` directory.
- `yarn commit` — Run commitizen. Alternative to `git commit`.
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for more information.