OB Editor

Welcome to the OB Editor project. This document provides instructions for setting up and running the application both locally and using Docker.

Online Editor

You can use the editor online at:

• OB 2.0 Editor

Docker Setup

Clone the repo to your local directory

git clone https://github.com/Open-Orange-Button/Orange-Button-Editor

Navigate to the OB Editor Code directory named "/Orange-Button-Editor"

Run pwd to confirm you are in the directory and use ls to ensure you can see all the files including the docker file.

pwd
ls

Docker Deployment

To run the OB Editor locally using Docker, follow these steps:

1. Ensure Docker is Installed: Make sure Docker is installed and running on your machine. You can download it from Docker's official website.

2. Build the Docker Image: Navigate to the root directory of your project and run the following command to build the Docker image:

3. Build and run the Docker Container: Start the container using Docker Compose at Port 3030:

   docker build -t obeditor-local .
   docker run -d -p 3030:80 obeditor-local

OR using Docker Compose (detached mode with -d)

 docker-compose up --build -d 

4. Access the Application: Open a web browser and go to http://localhost:3030 to access the OB Editor.

5. Stop the Container: To stop the running container, use:

   docker-compose down

6. View Logs: To view the logs of the running container, use:

   docker-compose logs

By following these steps, you can run the OB Editor locally using Docker. If you encounter any issues, please refer to the Docker documentation or seek further assistance.

Project Setup- Use these commands if you not using Docker.

Install Dependencies- Follow this

npm install

Compiles and Hot-reloads for Development

npm run serve

Compiles and Minifies for Production

npm run build

Run Your Tests

npm run test

Lints and Fixes Files

npm run lint

Customize Configuration

See the Configuration Reference.

---

This document is designed to help you quickly get started with the OB Editor, whether you're developing locally or deploying with Docker. For any additional questions or support, feel free to reach out to the project maintainers.