matt
/
opnform-host-nginx
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
opnform-host-nginx/docs/contributing/getting-started.mdx

38 lines
1.4 KiB
Plaintext
Raw Normal View History

Technical docs (#553) * WIP * Working on configuration * wip * Finished docs * Self hosted comparison + more links
2024-09-02 15:33:17 +02:00
---
Developer docker setup (#683) * Add build context to compose Signed-off-by: Daniel Ekman <knegge@gmail.com> * Update Docker documentation with build instructions Enhance Docker deployment documentation by: - Adding detailed instructions for building Docker images - Providing two methods for image building (Docker Compose and manual) - Clarifying how to use local images with docker-compose.override.yml * Add development Docker configuration Introduce development-specific Docker configuration: - Create docker-compose.dev.yml for local development setup - Add nginx.dev.conf with development CORS settings - Update Dockerfile.api to support environment-specific dependency installation - Configure development services with appropriate volumes and environment variables * Improve Docker and Development Documentation - Remove platform-specific ARM64 constraints in docker-compose.dev.yml - Enhance Nginx configuration with improved proxy and HMR settings - Update documentation for development setup and Docker deployment - Add new Docker development documentation page - Refactor getting started guide with clearer development instructions * Enhance Docker configuration and CI/CD pipeline - Update Docker Compose files with improved service configurations - Add database healthcheck in docker-compose.yml - Refactor GitHub Actions workflow for Docker image publishing - Optimize Dockerfile.api with multi-stage build and environment-specific configurations - Update Nginx configuration for development and production environments * Add GitHub Actions permissions for Docker image publishing Configure GitHub Actions workflow with explicit read and write permissions for content and packages to improve security and clarity of Docker image deployment process --------- Signed-off-by: Daniel Ekman <knegge@gmail.com> Co-authored-by: Daniel Ekman <knegge@gmail.com>
2025-01-28 17:52:48 +01:00
title: Getting Started
description: Learn how to contribute to OpnForm
Technical docs (#553) * WIP * Working on configuration * wip * Finished docs * Self hosted comparison + more links
2024-09-02 15:33:17 +02:00
---
Developer docker setup (#683) * Add build context to compose Signed-off-by: Daniel Ekman <knegge@gmail.com> * Update Docker documentation with build instructions Enhance Docker deployment documentation by: - Adding detailed instructions for building Docker images - Providing two methods for image building (Docker Compose and manual) - Clarifying how to use local images with docker-compose.override.yml * Add development Docker configuration Introduce development-specific Docker configuration: - Create docker-compose.dev.yml for local development setup - Add nginx.dev.conf with development CORS settings - Update Dockerfile.api to support environment-specific dependency installation - Configure development services with appropriate volumes and environment variables * Improve Docker and Development Documentation - Remove platform-specific ARM64 constraints in docker-compose.dev.yml - Enhance Nginx configuration with improved proxy and HMR settings - Update documentation for development setup and Docker deployment - Add new Docker development documentation page - Refactor getting started guide with clearer development instructions * Enhance Docker configuration and CI/CD pipeline - Update Docker Compose files with improved service configurations - Add database healthcheck in docker-compose.yml - Refactor GitHub Actions workflow for Docker image publishing - Optimize Dockerfile.api with multi-stage build and environment-specific configurations - Update Nginx configuration for development and production environments * Add GitHub Actions permissions for Docker image publishing Configure GitHub Actions workflow with explicit read and write permissions for content and packages to improve security and clarity of Docker image deployment process --------- Signed-off-by: Daniel Ekman <knegge@gmail.com> Co-authored-by: Daniel Ekman <knegge@gmail.com>
2025-01-28 17:52:48 +01:00
## Development Setup
### Docker Setup (Recommended)
The easiest way to get started with OpnForm development is to use our Docker-based development environment. It provides:
- Hot-reload for both frontend and backend
- All necessary services pre-configured
- Consistent development environment across all platforms
Follow our [Docker Development Setup](/deployment/docker-development) guide to get started.
### Manual Setup
If you prefer not to use Docker or need a custom setup, you can follow our [Local Deployment](/deployment/local-deployment#manual-setup) guide for manual installation instructions.
## Contributing Guidelines
Technical docs (#553) * WIP * Working on configuration * wip * Finished docs * Self hosted comparison + more links
2024-09-02 15:33:17 +02:00
Welcome to the OpnForm contributing guide! Here are some helpful links to get you started:
<CardGroup cols={2}>
<Card title="Setting up the development environment" icon="gear" href="../configuration/environment-variables">
Learn how to configure the environment variables for OpnForm.
</Card>
<Card title="Adding a new form block" icon="puzzle-piece" href="new-form-block">
Follow the steps to add a new form block to your project.
</Card>
<Card title="Integrating new services" icon="plug" href="new-integration">
Discover how to integrate new services with OpnForm.
</Card>
</CardGroup>
We sometimes offer bounties for certain issues. Check out our [bounties page](https://console.algora.io/org/OpnForm) for more information.