Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

44 lines (29 loc) · 1.41 KB
Raw

Contributing to Reforge

How to Contribute?

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:

  1. Fork the repository.
  2. Clone the forked repository to your local machine.
  3. Pick an issue from the Issues
  4. Create a new branch with a descriptive name. For example, feature/new-feature or fix/issue-123.
  5. Make changes to the codebase.
  6. Commit your changes with a descriptive commit message. For example, feat: add new feature or fix: issue-123.
  7. Push the changes to your forked repository.
  8. Create a pull request to the master branch of the original repository.

How to Run the Project?

To run the project, you need to have Node.js installed on your machine. Follow these steps to run the project:

  1. Clone the repository to your local machine.
  2. Install the dependencies using the following command:
npm install
  1. 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.

How to Build the Project?

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.