Skip to content

Latest commit

 

History

History
119 lines (76 loc) · 5.22 KB

CONTRIBUTING.md

File metadata and controls

119 lines (76 loc) · 5.22 KB
Raw

Contributing

Lookaround is a website-based neat tool to help you see your image in a 360-degree panorama-like view, also giving you useful customization opportunities. The tool is designed to be as user-friendly and intuitive as possible, so you can get the best results with minimal effort!

We are always looking for contributors who can help us improve the project, whether it is by adding new features, fixing bugs, writing documentation, or providing feedback. If you want to contribute to Lookaround, here are some guidelines to help you get started.

Prerequisites

Before you start contributing, you will need:

  • A GitHub account
  • A Heroku account (optional, but recommended)
  • A local copy of the project repository
  • A code editor of your choice
  • A basic knowledge of Python, Flask, HTML, CSS, and JavaScript
  • A basic knowledge of Three.js and WebGL (optional, but helpful)

Getting the project

To get a local copy of the project repository, you can either clone it or fork it.

  • To clone the repository, run the following command in your terminal:
git clone https://github.com/lyubomirt/Lookaround.git
  • To fork the repository, click the "Fork" button on the top right corner of the GitHub page, and then clone your forked repository.

Setting up the environment

To set up the environment for the project, you will need to install the required dependencies and run the Flask server.

  • To install the dependencies, run the following command in your terminal:
pip install -r requirements.txt
  • To run the Flask server, run the following command in your terminal:
python main.py
  • To access the website, open your browser and go to http://localhost:5000.

Testing the project

To test the project, you can use the website as a normal user and try out different features and settings. You can also use the developer tools in your browser to inspect the code and the console.

  • To open the developer tools, press Ctrl+Shift+I on Windows or Cmd+Option+I on Mac.
  • To see the console output, click the "Console" tab in the developer tools.
  • To see the code, click the "Sources" tab in the developer tools.

Making changes

To make changes to the project, you will need to create a new branch, make your edits, and commit them.

  • To create a new branch, run the following command in your terminal:
git checkout -b <branch-name>
  • To make your edits, use your code editor to modify the files in the project folder. You can also use the developer tools in your browser to test your changes.
  • To commit your changes, run the following commands in your terminal:
git add .
git commit -m "<commit-message>"

Pushing changes

To push your changes to the remote repository, you will need to create a pull request.

  • To push your changes, run the following command in your terminal:
git push origin <branch-name>
  • To create a pull request, go to the GitHub page of the project and click the "Compare & pull request" button.
  • To fill out the pull request, write a title and a description that explain your changes and why they are needed. You can also add labels, assignees, reviewers, and projects to your pull request.
  • To submit the pull request, click the "Create pull request" button.

Getting feedback

To get feedback on your pull request, you will need to wait for the project maintainer or the community moderators to review it. They may approve it, request changes, or comment on it.

  • To see the status of your pull request, go to the GitHub page of the project and click the "Pull requests" tab.
  • To see the comments on your pull request, click the "Conversation" tab in your pull request page.
  • To see the changes on your pull request, click the "Files changed" tab in your pull request page.
  • To respond to the comments or the requests, write a reply or make the requested changes and commit them.

Deploying the project

To deploy the project to Heroku, you will need to have a Heroku account and a Heroku app.

  • To create a Heroku account, go to https://www.heroku.com/ and sign up.
  • To create a Heroku app, go to https://dashboard.heroku.com/apps and click the "New" button, then click the "Create new app" button.
  • To connect your Heroku app to your GitHub repository, go to the "Deploy" tab in your Heroku app page, and select "GitHub" as the deployment method. Then, search for your repository and click the "Connect" button.
  • To deploy your Heroku app, go to the "Deploy" tab in your Heroku app page, and select the branch you want to deploy. Then, click the "Deploy Branch" button.

Following the code of conduct

To contribute to the project, you will need to follow the code of conduct that applies to the project and the community. The code of conduct outlines the rules and expectations for respectful and inclusive behavior, as well as the consequences for violating them.

Contact

If you have any questions, suggestions, or issues about contributing to the project, you can contact the project maintainer at:

  • Email: ternavski103@gmail.com
  • Discord: @lyubomirt
  • By creating a Discussion in the repository
  • My Discord server: The Orange Squad

Thank you for contributing to Lookaround, and for making it a better project for everyone!