You can contribute to our project by providing new features, fixing bugs, or improving the existing codebase. Here are the steps to contribute to this project:
- Fork the repository.
- Clone the forked repository to your local machine.
- Pick an issue from the Issues
- Create a new branch with a descriptive name. For example,
feature/new-feature
orfix/issue-123
. - Make changes to the codebase.
- Commit your changes with a descriptive commit message. For example,
feat: add new feature
orfix: issue-123
. - Push the changes to your forked repository.
- Create a pull request to the
master
branch of the original repository.
To run the project, you need to have Node.js installed on your machine. Follow these steps to run the project:
- Clone the repository to your local machine.
- Install the dependencies using the following command:
npm install
- Run the project using the following command:
npm run start
This command will start the development server and open the application in your default browser.
To build the project, you need to run the following command:
npm run make
This command will build the project and create an executable file for your operating system in the out
directory.