diff --git a/api/development.md b/api/development.md index 116518604..15e3c64a7 100644 --- a/api/development.md +++ b/api/development.md @@ -7,7 +7,6 @@ ### Development environment ```bash -**FOSS:** cd openreplay/api # Make your own copy of .env file and edit it as you want cp .env.dev .env @@ -17,18 +16,6 @@ mkdir .venv # Installing dependencies (pipenv will detect the .venv folder and use it as a target) pipenv install -r requirements.txt [--skip-lock] - -# Create a .venv folder to contain all you dependencies -mkdir .venv - -# Installing dependencies (pipenv will detect the .venv folder and use it as a target) -pipenv install -r requirements.txt [--skip-lock] - -# These commands must bu used everytime you make changes to FOSS. -# To clean the unused files before getting new ones -bash clean.sh -# To copy commun files from FOSS -bash prepare-dev.sh ``` ### Building and deploying locally diff --git a/ee/api/clean.sh b/ee/api/clean.sh new file mode 100755 index 000000000..59f723c80 --- /dev/null +++ b/ee/api/clean.sh @@ -0,0 +1,85 @@ +#!/bin/bash + +rm -rf ./chalicelib/core/alerts.py +rm -rf ./chalicelib/core/alerts_processor.py +rm -rf ./chalicelib/core/announcements.py +rm -rf ./chalicelib/core/collaboration_slack.py +rm -rf ./chalicelib/core/errors_favorite_viewed.py +rm -rf ./chalicelib/core/events.py +rm -rf ./chalicelib/core/events_ios.py +rm -rf ./chalicelib/core/dashboards.py +rm -rf ./chalicelib/core/funnels.py +rm -rf ./chalicelib/core/integration_base.py +rm -rf ./chalicelib/core/integration_base_issue.py +rm -rf ./chalicelib/core/integration_github.py +rm -rf ./chalicelib/core/integration_github_issue.py +rm -rf ./chalicelib/core/integration_jira_cloud.py +rm -rf ./chalicelib/core/integration_jira_cloud_issue.py +rm -rf ./chalicelib/core/integrations_manager.py +rm -rf ./chalicelib/core/issues.py +rm -rf ./chalicelib/core/jobs.py +rm -rf ./chalicelib/core/log_tool_bugsnag.py +rm -rf ./chalicelib/core/log_tool_cloudwatch.py +rm -rf ./chalicelib/core/log_tool_datadog.py +rm -rf ./chalicelib/core/log_tool_elasticsearch.py +rm -rf ./chalicelib/core/log_tool_newrelic.py +rm -rf ./chalicelib/core/log_tool_rollbar.py +rm -rf ./chalicelib/core/log_tool_sentry.py +rm -rf ./chalicelib/core/log_tool_stackdriver.py +rm -rf ./chalicelib/core/log_tool_sumologic.py +rm -rf ./chalicelib/core/metadata.py +rm -rf ./chalicelib/core/mobile.py +rm -rf ./chalicelib/core/sessions.py +rm -rf ./chalicelib/core/sessions_assignments.py +rm -rf ./chalicelib/core/sessions_favorite_viewed.py +rm -rf ./chalicelib/core/sessions_metas.py +rm -rf ./chalicelib/core/sessions_mobs.py +rm -rf ./chalicelib/core/significance.py +rm -rf ./chalicelib/core/slack.py +rm -rf ./chalicelib/core/socket_ios.py +rm -rf ./chalicelib/core/sourcemaps.py +rm -rf ./chalicelib/core/sourcemaps_parser.py +rm -rf ./chalicelib/core/weekly_report.py +rm -rf ./chalicelib/saml +rm -rf ./chalicelib/utils/html/ +rm -rf ./chalicelib/utils/__init__.py +rm -rf ./chalicelib/utils/args_transformer.py +rm -rf ./chalicelib/utils/captcha.py +rm -rf ./chalicelib/utils/dev.py +rm -rf ./chalicelib/utils/email_handler.py +rm -rf ./chalicelib/utils/email_helper.py +rm -rf ./chalicelib/utils/event_filter_definition.py +rm -rf ./chalicelib/utils/github_client_v3.py +rm -rf ./chalicelib/utils/helper.py +rm -rf ./chalicelib/utils/jira_client.py +rm -rf ./chalicelib/utils/metrics_helper.py +rm -rf ./chalicelib/utils/pg_client.py +rm -rf ./chalicelib/utils/s3.py +rm -rf ./chalicelib/utils/smtp.py +rm -rf ./chalicelib/utils/strings.py +rm -rf ./chalicelib/utils/TimeUTC.py +rm -rf ./routers/app/__init__.py +rm -rf ./routers/crons/__init__.py +rm -rf ./routers/subs/__init__.py +rm -rf ./routers/__init__.py +rm -rf ./chalicelib/core/assist.py +rm -rf ./auth/auth_apikey.py +rm -rf ./auth/auth_jwt.py +rm -rf ./build.sh +rm -rf ./routers/core.py +rm -rf ./routers/crons/core_crons.py +rm -rf ./routers/subs/dashboard.py +rm -rf ./db_changes.sql +rm -rf ./Dockerfile.bundle +rm -rf ./entrypoint.bundle.sh +rm -rf ./entrypoint.sh +rm -rf ./chalicelib/core/heatmaps.py +rm -rf ./routers/subs/insights.py +rm -rf ./schemas.py +rm -rf ./routers/subs/v1_api.py +rm -rf ./routers/subs/metrics.py +rm -rf ./chalicelib/core/custom_metrics.py +rm -rf ./chalicelib/core/performance_event.py +rm -rf ./chalicelib/core/saved_search.py +rm -rf ./app_alerts.py +rm -rf ./build_alerts.sh diff --git a/ee/api/development.md b/ee/api/development.md new file mode 100644 index 000000000..d980a24d7 --- /dev/null +++ b/ee/api/development.md @@ -0,0 +1,36 @@ +### Prerequisites + +- [Vagrant](../scripts/vagrant/README.md) +- Python 3.9 +- Pipenv + +### Development environment + +```bash +cd openreplay/ee/api +# Make your own copy of .env file and edit it as you want +cp .env.dev .env + +# Create a .venv folder to contain all you dependencies +mkdir .venv + +# Installing dependencies (pipenv will detect the .venv folder and use it as a target) +pipenv install -r requirements.txt [--skip-lock] + +# These commands must bu used everytime you make changes to FOSS. +# To clean the unused files before getting new ones +bash clean.sh +# To copy commun files from FOSS +bash prepare-dev.sh +``` + +### Building and deploying locally + +```bash +cd openreplay-contributions +vagrant ssh +cd openreplay-dev/openreplay/scripts/helmcharts +# For complete list of options +# bash local_deploy.sh help +bash local_deploy.sh api +``` diff --git a/ee/api/prepare-local.sh b/ee/api/prepare-dev.sh similarity index 100% rename from ee/api/prepare-local.sh rename to ee/api/prepare-dev.sh