Skip to content

Latest commit

 

History

History
111 lines (79 loc) · 4.51 KB

CONTRIBUTING.md

File metadata and controls

111 lines (79 loc) · 4.51 KB
Raw

Contributing to SWFT - Simple Web-based File Transfer

Thank you for considering contributing to SWFT! We appreciate your interest in making our web-based file sharing service even better. This document provides guidelines for contributing to the project. Please take a moment to read and follow these guidelines to ensure a smooth and collaborative development process.

Table of Contents

Code of Conduct

Before contributing, please review our Code of Conduct. We expect all contributors to adhere to this code to create a welcoming and inclusive community.

How Can I Contribute?

Reporting Bugs

If you encounter a bug while using SWFT or have identified a potential issue, please open a new issue on our GitHub repository. Ensure that your report includes detailed information about the problem, such as the steps to reproduce it and any relevant error messages.

Suggesting Enhancements

If you have ideas for new features or improvements to existing ones, feel free to create an enhancement request on GitHub. Be clear and specific about the proposed enhancement and how it would benefit SWFT.

Submitting Changes

If you'd like to contribute code to SWFT, follow these steps:

  1. Fork the SWFT repository on GitHub.
  2. Create a new branch from the main branch to work on your changes.
  3. Make your changes and ensure that they follow the project's coding standards.
  4. Test your changes thoroughly.
  5. Create a pull request (PR) describing your changes, explaining their purpose, and providing steps for testing.
  6. Be prepared to respond to feedback and make necessary adjustments.

Development Setup

To set up a development environment for SWFT, follow these steps:

Prerequisites

  • Python 3.x
  • Flask (Python web framework)
  • pip (Python package manager)

Installation

Clone the SWFT repository to your server:

git clone https://github.com/nnisarggada/swft
cd swft

Create a Python virtual environment and activate it:

python -m venv env
source env/bin/activate

Install the required dependencies from the requirements.txt file:

pip install -r requirements.txt

Configuration

Edit the SWFT configuration in the .env or main.py file to customize settings such as the port, URL, folder for storing files, and the time until files are deleted. Modify the following variables as needed:

# -------------------------------------------------------------------
# The following .env file needs to be changed before running the app using following variables: [SMTP_x and UMAMI_x are optional to use for sending emails]
# -------------------------------------------------------------------

URL = "share.nnisarg.in" # URL of the hosted app
TEMP_FOLDER = "share_temp" # Folder where the files will stored temporarily
MAX_TEMP_FOLDER_SIZE = 50 # Maximum size of the temporary folder in GB (50GB)
DEFAULT_DEL_TIME = 3 # Time until files will be deleted in hours (3 hours)
MAX_CONTENT_LENGTH = 100 # Maximum file size allowed in MB (100MB)
MAX_DEL_TIME = 168 # Maximum time until files will be deleted in hours (24 hours)
UPLOAD_LOG_FILE = "upload.log" # Log file for uploads
ACCESS_LOG_FILE = "access.log" # Log file for access
MAX_LOG_ENTRIES = 500 # Maximum number of log entries for each log file
SMTP_SERVER = "smtp.gmail.com" # SMTP server URL without the protocol and port
SMTP_PORT = 587 # SMTP port
SMTP_USERNAME = "swft@nnisarg.in"  # Replace with username
SMTP_FROM = "SWFT by Nnisarg Gada <swft@nnisarg.in>" # Replace with your email
SMTP_PASSWORD = "yourpassword"  # Replace with your email password
UMAMI_SRC = "https://umami.ls/script.js" # Replace with your Umami script src
UMAMI_ID = "your_website_id" # Replace with your Umami website id
# -------------------------------------------------------------------

Running the App

Run the SWFT app by specifying the port number:

gunicorn -b 0.0.0.0:5000 main:app

Here, 5000 is the port on which the app will run. You can access the SWFT web interface in your web browser at http://localhost:5000.