https://github.com/404wolf/code-ship

A portal to share live updated text using PHP and javascript request polling.
https://github.com/404wolf/code-ship

Last synced: 7 days ago
JSON representation

A portal to share live updated text using PHP and javascript request polling.

• Host: GitHub
• URL: https://github.com/404wolf/code-ship
• Owner: 404Wolf
• Created: 2024-03-12T05:59:14.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-03-20T05:37:21.000Z (8 months ago)
• Last Synced: 2024-03-20T19:29:41.122Z (8 months ago)
• Language: PHP
• Size: 40 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Codeship 

Code ship is a collaborative code-sharing platform where users can share code in real-time. The platform is dockerized and utilizes JavaScript and PHP to create a synchronized textbox experience among multiple clients. The synchronization is achieved through polling a `contents.json` file, ensuring that all clients stay up-to-date with the latest code changes.

## Features

- **Real-time Code Synchronization:** The textbox allows multiple users to collaborate on code simultaneously, with changes reflected in real-time across all connected clients.

- **Dockerized Environment:** The application is containerized using Docker, providing a consistent and reproducible environment for deployment.

- **Polling `contents.json`:** Code synchronization is facilitated by regularly polling the `contents.json` file, which contains the latest code changes. This ensures that all clients are aware of the current state of the code.

## Technologies Used

- **JavaScript (Frontend):** The client-side logic is implemented using JavaScript to handle user interactions and update the code textbox in real-time.

- **PHP (Backend):** PHP is used to handle server-side logic, manage file operations, and serve the `contents.json` file for code synchronization.

- **Docker:** The application is containerized using Docker, allowing for easy deployment and scalability.

## Getting Started

### Prerequisites

- Docker engine.

### Installation

1. Clone the repository: `git clone https://github.com/404Wolf/Code-Ship.git`

2. Navigate to the project directory: `cd Code-Ship`

3. Build the Docker image: `docker compose up`

4. Access the application in your web browser: `http://0.0.0.0:8080

## License

This project is licensed under the MIT License.