To work on an open-source project, you will first need to make your copy of the repository. To do this, you should fork the repository and then clone it so that you have a local working copy.

Get your own Fork/Copy of repository by clicking Fork button right upper corner.

After the repository is forked, you can now clone it so that you have a local working copy of the codebase.

To make your local copy of the repository follow the steps:

• Open the Command Prompt
• Type this command:

$ git clone https://github.com/<your-github-username>/pixelvibe

This is one of the very important step that you should follow to contribute in Open Source. A branch helps to manage the workflow, isolate your code and does not creates a mess. To create a new branch:

$ git branch <name_of_branch>
$ git checkout -b <name_of_branch>

Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)

git pull origin main

1. Create a Virtual Environment

• On macOS and Linux:

    python3 -m venv env

• Windows

    py -m venv env

2. Activate the Virtual Environment

• On Windows

  .\env\Scripts\activate

• On macOS and Linux:

  source env/bin/activate

3. Install dependencies using

pip install -r requirements.txt

4. Run server using

flask run

5. Go to http://127.0.0.1:5000/ and enjoy the application.