Skip to content

Commit

Permalink
Merge branch 'master' of github.com:open-eats/OpenEats
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanNoelk committed Mar 4, 2019
2 parents 77505ad + ae4e22a commit dea955f
Show file tree
Hide file tree
Showing 4 changed files with 359 additions and 65 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ The usage for the app is intended for a single user or a small group. For my per
- Quickly print recipe.
- Linking recipes and ingredient grouping.

### [Read the docs on getting started here!](https://github.com/open-eats/OpenEats/blob/master/docs/Running_the_App.md)
### [Read the docs on getting started here!](docs/Running_the_App.md)

If you don't wish to use docker, see installation instructions here:
[Markdown](https://github.com/open-eats/OpenEats/blob/master/docs/Running_the_App_Without_Docker.md) OR [Media Wiki!](https://wiki.tothnet.hu/index.php/Install_OpenEats_without_Docker_and_run_on_Apache2)
[Markdown](docs/Running_the_App_Without_Docker.md) OR [Media Wiki!](https://wiki.tothnet.hu/index.php/Install_OpenEats_without_Docker_and_run_on_Apache2)


### [The Update guide can be found here!](https://github.com/open-eats/OpenEats/blob/master/docs/Updating_the_App.md)
### [The Update guide can be found here!](docs/Updating_the_App.md)

# Contributing
Please read the [contribution guidelines](https://github.com/open-eats/OpenEats/blob/master/CONTRIBUTING.md) in order to make the contribution process easy and effective for everyone involved.
Please read the [contribution guidelines](CONTRIBUTING.md) in order to make the contribution process easy and effective for everyone involved.

For a guide on how to setup an environment for development see [this guide](https://github.com/open-eats/OpenEats/blob/master/docs/Running_the_App_in_dev.md).
For a guide on how to setup an environment for development see [this guide](docs/Running_the_App_in_dev.md).
4 changes: 2 additions & 2 deletions docs/Running_the_App.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Running the App

The recommended way to run this app is with docker and docker-compose. You can install docker [here](https://www.docker.com/community-edition#/download) and docker-compose [here](https://docs.docker.com/compose/install/#prerequisites). If you are not familiar with docker you can read more about it on [their website](https://www.docker.com/what-docker).
The recommended way to run this app is with docker and docker-compose. You can install docker [here](https://hub.docker.com/search/?type=edition&offering=community) and docker-compose [here](https://docs.docker.com/compose/install/#prerequisites). If you are not familiar with docker you can read more about it on [their website](https://www.docker.com/what-docker).

### Setup docker configuration for production

Expand Down Expand Up @@ -87,5 +87,5 @@ docker-compose -f docker-prod.yml run --rm --entrypoint 'sh' api
./manage.py loaddata ing_data.json
```

### Setting up a Proxy Server
### Setting up a Proxy Server and HTTPS
The nginx reverse proxy will default to run on port 80. You will most likely want to change the port that nginx runs on. See [Creating a proxy server for docker](Creating_a_proxy_server_for_docker.md) for more information on how to configure an nginx server to serve OpenEats.
Loading

0 comments on commit dea955f

Please sign in to comment.