Getting Started

Contributing to Enkyrpt

To get started make sure you have nodejs and nvm installed on your system

Prerequisites

• npm

  nvm install 16
  nvm use 16
  npm install yarn -g

Installation

1. Clone the repo

   git clone https://github.com/enkryptcom/enKrypt.git

2. Install NPM packages

   yarn install

3. Build the project and watch for changes

   yarn build:all
   yarn watch-extension # chromium based browsers
   yarn watch:firefox # firefox

4. Build the project for release

   yarn build:all
   yarn build:chrome # chromium based browsers
   yarn build:firefox # firefox

5. Add to your browser

   • Chrome/Brave/Opera

   • Firefox

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project

2. Create your Feature Branch (git checkout -b feature/AmazingFeature)

3. Commit your Changes (git commit -m 'Add some AmazingFeature')

4. Push to the Branch (git push origin feature/AmazingFeature)

5. Open a Pull Request