https://github.com/darenmalfait/remmy

https://github.com/darenmalfait/remmy

Last synced: 16 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/darenmalfait/remmy
• Owner: darenmalfait
• Created: 2023-02-28T07:42:34.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-04-22T12:28:43.000Z (almost 2 years ago)
• Last Synced: 2023-12-19T17:51:22.282Z (about 1 year ago)
• Language: TypeScript
• Size: 12 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Remmy

Remmy is an Electron application built with React and Tailwind CSS. The application allows users to add files and rename them based on the configured parameters.

## Installation

To install Remmy, please follow the steps below:

* Clone the repository to your local machine.

* Open your terminal and navigate to the root directory of the project.

* Run the command `pnpm i` to install all the necessary packages.

## Usage

To run Remmy locally, please follow the steps below:

* Open your terminal and navigate to the root directory of the project.

* Run the command `pnpm dev`.

* Remmy will launch in your task bar.

## Features

Remmy provides users with the following features:

* Add files to the application

* Rename files based on configured parameters

* View and manage saved parameters

## Contributing

If you wish to contribute to Remmy, please follow the steps below:

* Fork the repository to your own GitHub account.

* Create a new branch from the develop branch with a descriptive name of your changes.

* Make the necessary changes and commit them to your branch.

* Push your changes to your forked repository.

* Create a pull request from your branch to the develop branch of the original repository.

## License

Remmy is licensed under the MIT license. Please see the LICENSE file for more information.

Credits

Remmy was created by Daren.