mirror of
https://github.com/actualbudget/actual.git
synced 2026-03-11 17:47:00 -05:00
Added Dev Container (#1023)
This commit is contained in:
@@ -32,3 +32,15 @@ We welcome all contributions from the community. If you have an idea for a featu
|
||||
If you do not have ideas what to build: the issue list is always a good starting point. Look for issues labeled with "[help wanted](https://github.com/actualbudget/actual/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22)".
|
||||
|
||||
For first time contributions you can also filter the issues labeled with "[good first issue](https://github.com/actualbudget/actual/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)".
|
||||
|
||||
|
||||
## Development Environment
|
||||
If you would like to contribute you can fork this repository and create a branch specific to the project you are working on.
|
||||
|
||||
There are two options for developing:
|
||||
1. Yarn
|
||||
- This is the traditional way to get an envrionment stood up. Run `yarn` to install the dependencies followed by `yarn start:browser` to start the development server. You will then be able to access Actual at `localhost:3001`.
|
||||
2. Docker Compose
|
||||
- If you prefer to work with docker containers, a `docker-compose.yml` file is included. Run `docker compose up -d` to start Actual. It will be accessible at `localhost:3001`.
|
||||
|
||||
Both options above will dynamically update as you make changes to files. If you are making changes to the front end UI, you may have to reload the page to see any changes you make.
|
||||
|
||||
11
Dockerfile
Normal file
11
Dockerfile
Normal file
@@ -0,0 +1,11 @@
|
||||
###################################################
|
||||
# This Dockerfile is used by the docker-compose.yml
|
||||
# file to build the development container.
|
||||
# Do not make any changes here unless you know what
|
||||
# you are doing.
|
||||
###################################################
|
||||
|
||||
FROM node:16-bullseye as dev
|
||||
RUN apt-get update -y && apt-get upgrade -y && apt-get install -y openssl
|
||||
WORKDIR /app
|
||||
CMD ["sh", "./docker-start.sh"]
|
||||
16
docker-compose.yml
Normal file
16
docker-compose.yml
Normal file
@@ -0,0 +1,16 @@
|
||||
###################################################
|
||||
# This creates and stands up the development
|
||||
# docker container. Depends on the Dockerfile and
|
||||
# docker-start.sh files.
|
||||
###################################################
|
||||
|
||||
services:
|
||||
actual-development:
|
||||
build: .
|
||||
image: actual-development
|
||||
ports:
|
||||
- '3001:3001'
|
||||
volumes:
|
||||
- '.:/app'
|
||||
restart: no
|
||||
|
||||
13
docker-start.sh
Normal file
13
docker-start.sh
Normal file
@@ -0,0 +1,13 @@
|
||||
#####################################################
|
||||
# This startup script is used by the docker container
|
||||
# to check if the node_modules folder is empty and
|
||||
# if so, run yarn to install the dependencies.
|
||||
#####################################################
|
||||
|
||||
#!/bin/sh
|
||||
|
||||
if [ ! -d "node_modules" ] || [ "$(ls -A node_modules)" = "" ]; then
|
||||
yarn
|
||||
fi
|
||||
|
||||
yarn start:browser
|
||||
6
upcoming-release-notes/1023.md
Normal file
6
upcoming-release-notes/1023.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
category: Features
|
||||
authors: [jonezy35]
|
||||
---
|
||||
|
||||
Created development docker container
|
||||
Reference in New Issue
Block a user