development.md

Development

This section is intended for developers who wish to contribute to this project. Follow the steps below to set up your development environment and start contributing.

Prerequisites

• Git
• Python (version 3.7 or higher)
• pip (Python package installer)
• yarn (Node.js package installer)

Setting Up the Development Environment

1. Clone the Repository

   Begin by cloning the repository to your local machine using Git:

   git clone https://github.com/nathan-fiscaletti/keyboardsounds.git

2. Navigate to the Project Directory

   Change to the project directory:

   cd keyboardsounds

3. Install Dependencies: Python

   Install the project dependencies using pip:

   pip install -r requirements.txt

4. Install Dependencies: Node.js

   Install the project dependencies using yarn:

   cd application
   yarn

Running the Project Locally

It is recommended that you install the package in editable mode to allow you to make changes to the code and see the changes reflected in the application.

• To install the package in editable mode, use the following command:

  pip install -e .

  This command will install the package in editable mode, allowing you to make changes to the code and see the changes reflected in the application.

Running the Desktop Application

To run the desktop application, navigate to the application directory and run the following command:

yarn start

Contributing

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

Submitting Pull Requests

1. Fork the repository and create your branch from master.
2. If you've added code, ensure your code adheres to the project's coding conventions.
3. Update documentation as necessary.
4. Submit your pull request with a detailed description of your changes.

Getting Help

Should you have any questions or encounter issues, feel free to open an issue on the repository, and I'll do my best to address it.