Skip to content

Nayra000/passwordManager

Repository files navigation

Password Manager

Welcome to Password-Manager, a RESTful API to store your passwords safely and smoothly.

Badges

NodeJS Express.js MongoDB JWT Git GitHub GitHub Actions Vercel

About

This Password-Manager REST API allows users to securely store and manage their passwords in a centralized database. With this API, users can create, update, delete, and retrieve their password records using HTTP methods. It provides a convenient and secure way to organize and access sensitive information.

Tech/Framework used

Getting Started

Prerequisites

Before you begin, ensure you have met the following requirements:

  • Node.js and npm installed
  • MongoDB installed and running

Installation

To install the Password-Manager, follow these steps:

  1. Clone the repository:

    git clone <repo-link>
  2. Navigate to the project directory:

    cd <app-directory>
  3. Install dependencies:

    npm install
  4. Set up environment variables: To run this project, you will need to add the following environment variables to your .env file
    HOST=
    PORT=
    DATABASE=
    DATABASE_PASSWORD=
    SECRET_KEY= jwt secrete key
    EXPIRE_IN= jwt expired date
    JWT_COOKIE_EXPIRES_IN=
    EMAIL_USERNAME=
    EMAIL_PASSWORD=
    EMAIL_HOST=
    EMAIL_PORT=

  5. Start the application:

    npm run start

Usage

Once the application is up and running, you can visit http://localhost:<port> or deployed link in your api-testing tool like postman to explore the application

API

Password-Manager provides a RESTful API to performe various actions. You can find the API documentation here 🔗.

Features

  • User registration and authentication
  • Sign up, Log in, Logout, Update, and reset password.
  • crud operations for passwords to each user

To Do

  • make a more-secure login approach
  • replace mail transporter with real one
  • set password generator