Skip to content

Latest commit

 

History

History
76 lines (58 loc) · 2.73 KB

README.md

File metadata and controls

76 lines (58 loc) · 2.73 KB

password.live

🔒 Generate simple or complex passwords directly from your web browser. https://password.live

Build Status MIT License lerna

Overview

Password.live is a web-based password generator written in React, Redux, and Node. The main idea was to create a simple web-based application to generate both simple and complex passwords. The application does not log or store any passwords that are created and is secured by SSL. A docker image is also provided to easily run password.live locally as well.

Development

Password.live utilizes Lerna & npm for package management. This project is a monorepo, meaning the client and the server are in the same repository. Ensure you have node/npm installed. Then, install root dependencies by running:

npm install

Dependencies for subprojects are automatically installed through a postinstall hook running lerna bootstrap. You can manually bootstrap all dependencies by running:

npm run bootstrap

Run the application

Start the client and the server by running:

npm run serve

Visit localhost:5500 to view the application. The server will be running on localhost:5501.

Run tests

To run all tests, run the following in the root directory:

npm run test

To run tests for only the server:

npm run test:server

To run tests for only the client:

npm run test:client

Building for production

To build the application for production (as it does in our continuous integration builds), run:

npm run compile

To then run the production server (which includes the client), run:

npm run start

The production server will then be running on localhost:8080.

Contributing

Interested in contributing? Read CONTRIBUTING.md to learn more.

License

This software is released under the MIT license. See LICENSE for more details.