pythoninthegrass/enviro

A platform for managing and using containerized dev environments

Onix Enviro

Enviro accelerates your workflow with ready-to-use, cloud-based development environments.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Onix Enviro is a cloud development platform for instant, full-featured dev environments in your browser. Eliminate local setup, run Docker, forward ports, use templates, and more.

• No local setup needed
• Run VS Code in browser
• Remote Docker & environment support
• Full stack flexibility
• Environment starter templates

(back to top)

Built With

• 
• 
• 
• 

(back to top)

Getting Started

This guide will help you install and set up Onix Enviro on your infrastructure.

Prerequisites

• Docker and Docker Compose installed on your server or local machine.
• A supported OS (Linux recommended).
• Basic knowledge of Docker and command-line usage.

Installation

1. Clone the Repository

git clone https://github.com/ExoOnix/enviro.git
cd enviro

2. Configure Environment Variables

Copy the example environment file and edit it to match your configuration:

cp .env.example .env
# Edit .env with your preferred editor

Set values for database, Django secret key, allowed hosts, etc.

3. Start the Services

Run the following command to start all services:

docker compose -f docker-compose.production.yaml up --build -d

4. Apply Database Migrations

After the containers are running, apply Django migrations:

docker compose -f docker-compose.production.yaml exec django-web poetry run python manage.py migrate

5. Setup environment templates (Optional)

To populate the database with the official environment templates, run:

docker compose -f docker-compose.production.yaml exec django-web poetry run python manage.py loaddata apps/env_manager/fixtures/templates.json

6. Create a Superuser (Optional)

To access the Django admin, create a superuser:

docker compose -f docker-compose.production.yaml exec django-web poetry run python manage.py createsuperuser

7. Access the Platform

• Visit http://localhost:8081 (or your server's IP/domain) in your browser. (Port can be changed in the docker compose)
• Log in or sign up to start using Onix Enviro.

(back to top)

Usage

After authenticating, click create project and start programming!

Rough Roadmap

• Environment Templates
• Subdomain editors
• Subdomain port forwarding
• More lightweight self hosting version of this app
• Kubernetes support
• AI features
• Integrate custom editor OnixIDE

See the open issues for a full list of proposed features (and known issues).

Feel free to suggest any new features.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Top contributors:

License

Distributed under the AGPL-3.0. See LICENSE.txt for more information.

(back to top)

Contact

Mark Shapirovskyy - mshapirovskyy@gmail.com

Project Link: https://github.com/ExoOnix/enviro

(back to top)