screenie Docs

Appearance

Contribution Guide ​

Follow these steps to contribute to our repositories:

Fork and Clone the Repository ​

  • Fork the repository, you want to contribute to on GitHub.
  • Clone your fork to your local system using:
sh
git clone https://github.com/yourname/example.git
  • Navigate to the cloned directory:
sh
cd example

Install Dependencies ​

Run the following command to install dependencies:

bash
npm install

Start the app ​

Run one of the following commands to start the app:

bash
node .
# or
npm start
# or
pm2 start . --name screenie # if using linux

This will start a local server and provide a URL to preview your changes.

Make Your Contribution ​

  • Edit or make new files in the repository folder.

Submit a Pull Request ​

  • Push your changes to your forked repository.
  • Create a pull request to merge your changes into the main repository.

Thank you for contributing!

Changelog