Skip to content

Commit

Permalink
Fix Docker Image Name and Update Setup Instructions (#44) (#104)
Browse files Browse the repository at this point in the history
* update docker instructions

* add dockerignore file

* add: locally using the Containerfile
  • Loading branch information
anxkhn authored Feb 10, 2025
1 parent 6c58aad commit b863f59
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 2 deletions.
89 changes: 89 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Git
.git
.gitignore
.gitattributes


# CI
.codeclimate.yml
.travis.yml
.taskcluster.yml

# Docker
docker-compose.yml
Dockerfile
.docker
.dockerignore

# Byte-compiled / optimized / DLL files
**/__pycache__/
**/*.py[cod]

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.cache
nosetests.xml
coverage.xml

# Translations
*.mo
*.pot

# Django stuff:
*.log

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Virtual environment
.env
.venv/
venv/

# PyCharm
.idea

# Python mode for VIM
.ropeproject
**/.ropeproject

# Vim swap files
**/*.swp

# VS Code
.vscode/
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,17 @@ so there is nothing to configure.

### Using docker

Download the latest image from github container regiimage from github container registry:
You can either download the latest image from GitHub container registry:

```sh
$ docker run ghcr.io/openclimatefix/fake-api:latest
$ docker run ghcr.io/openclimatefix/india-api:latest
```

Or build and run locally using the Containerfile:

```sh
$ docker build -t india-api .
$ docker run india-api
```

### Using python(v3.11.x)
Expand Down

0 comments on commit b863f59

Please sign in to comment.