contribution framework updates
1
.gitignore
vendored
@ -12,6 +12,7 @@ mealie/data/img/*
|
||||
|
||||
#Exception to keep folders
|
||||
!mealie/data/backups/.gitkeep
|
||||
!mealie/data/backups/dev_sample_data*
|
||||
!mealie/data/debug/.gitkeep
|
||||
!mealie/data/img/.gitkeep
|
||||
|
||||
|
@ -18,6 +18,7 @@ WORKDIR /app
|
||||
RUN pip install -r requirements.txt
|
||||
|
||||
COPY ./mealie /app
|
||||
COPY ./mealie/data/templates/recipes.md /app/data/templates/
|
||||
COPY --from=build-stage /app/dist /app/dist
|
||||
|
||||
|
||||
|
@ -1,3 +1,17 @@
|
||||
# Getting A Developer Instance Started
|
||||
For the best experience developing I recommend using docker. I've used both WSL2 and Ubuntu to develop mealie and have had no issues with cross compatibility with docker. 2 Scripts are available along ith docker-compose files to make development instances easier. After cloning the repo you can set the scripts in /dev/scripts/ as executable and then use VSCode tasks to execute the scripts or execute them from the CLI.
|
||||
|
||||
`docker-compose.dev.sh` Will spin up a development stack with hot-reloading enabled.
|
||||
`docker-compose.sh` Will spin up a production version of the stack.
|
||||
|
||||
After the stack is running navigate to the [admin page localhost:9090/settings/site](http://localhost:9090/settings/site). On the Backups and Exports section import the backup labeled dev_sample_data_{DATE}.zip. This will give you some recipe data to work with.
|
||||
|
||||
Once you're up and running you should be able to make changes and see them reflected on the frontend/backend. If you're not sure what to work on you can check:
|
||||
|
||||
- The Working Todo's below.
|
||||
- The [Development Road Map](https://hay-kot.github.io/mealie/2.0%20-%20roadmap/)
|
||||
- The [Current Open Issues](https://github.com/hay-kot/mealie/issues)
|
||||
|
||||
# Working Todos
|
||||
|
||||
Frontend
|
||||
|
Before Width: | Height: | Size: 16 KiB |
Before Width: | Height: | Size: 3.4 MiB |
Before Width: | Height: | Size: 136 KiB |
Before Width: | Height: | Size: 1.1 MiB |
Before Width: | Height: | Size: 997 KiB |
Before Width: | Height: | Size: 1.2 MiB |
Before Width: | Height: | Size: 812 KiB |
Before Width: | Height: | Size: 53 KiB |
Before Width: | Height: | Size: 889 KiB |
Before Width: | Height: | Size: 137 KiB |
Before Width: | Height: | Size: 1.1 MiB |
Before Width: | Height: | Size: 312 KiB |
Before Width: | Height: | Size: 1.0 MiB |
Before Width: | Height: | Size: 324 KiB |
Before Width: | Height: | Size: 1.7 MiB |