Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove render.io from README.md #511

Merged
merged 1 commit into from
Mar 13, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/django.yml
Original file line number Diff line number Diff line change
@@ -56,7 +56,6 @@ jobs:
deploy_to_heroku:
runs-on: ubuntu-latest
needs: build
# The project is currently hosted on render.com
if: false
steps:
- uses: actions/checkout@v4
20 changes: 2 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -27,7 +27,6 @@
- [Helpful commands for local development with `docker compose`](#helpful-commands-for-local-development-with-docker-compose)
- [Deployment](#deployment)
* [Heroku](#heroku)
* [Render](#render)
* [AWS ECS](#aws-ecs)
- [Linters and Code Formatters](#linters-and-code-formatters)

@@ -84,7 +83,7 @@ Few important things:
- `mypy` is ran as a build step in [`.github/workflows/django.yml`](.github/workflows/django.yml)
- ⚠️ The provided configuration is quite minimal. **You should figure out your team needs & configure accordingly** - <https://mypy.readthedocs.io/en/stable/config_file.html>
- It comes with GitHub Actions support, [based on that article](https://hacksoft.io/github-actions-in-action-setting-up-django-and-postgres/)
- It can be easily deployed to Heroku, Render or AWS ECS.
- It can be easily deployed to Heroku or AWS ECS.
- It comes with an example list API, that uses [`django-filter`](https://django-filter.readthedocs.io/en/stable/) for filtering & pagination from DRF.
- It comes with setup for [Django Debug Toolbar](https://django-debug-toolbar.readthedocs.io/en/latest/)
- It comes with examples for writing tests with fakes & factories, based on the following articles - <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories>, <https://www.hacksoft.io/blog/improve-your-tests-django-fakes-and-factories-advanced-usage>
@@ -329,7 +328,7 @@ docker compose run django python manage.py shell

## Deployment

This project is ready to be deployed either on **Heroku** **Render** or **AWS ECS**.
This project is ready to be deployed either on **Heroku** or **AWS ECS**.

### Heroku

@@ -363,21 +362,6 @@ On top of that, we've added `gunicorn.conf.py` with some example settings.
1. Worker settings - <https://docs.gunicorn.org/en/latest/settings.html#worker-processes>
1. A brief description of the architecture of Gunicorn - <https://docs.gunicorn.org/en/latest/design.html>

### Render

To get an overview of how Render deployment works, we recommend reading this first - <https://render.com/docs/deploy-django>

There's a current deployment that can be found here - <https://django-styleguide.hacksoft.io/>

**Files related to Render deployment:**

1. `render.yaml`
- Describes the setup. Also known as [Render Blueprint](https://render.com/docs/blueprint-spec)
1. `docker/*_entrypoint.sh`
- Entrypoint for every different process type.
1. `docker/production.Dockerfile`
- Dockerfile for production build.

### AWS ECS

_Coming soon_