https://github.com/city-of-helsinki/pysakoinnin-sahk-asiointi

Pysäköinnin sähköinen asiointi
https://github.com/city-of-helsinki/pysakoinnin-sahk-asiointi

Last synced: about 2 months ago
JSON representation

Pysäköinnin sähköinen asiointi

• Host: GitHub
• URL: https://github.com/city-of-helsinki/pysakoinnin-sahk-asiointi
• Owner: City-of-Helsinki
• Created: 2022-10-12T11:52:36.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-04-12T08:35:17.000Z (9 months ago)
• Last Synced: 2024-04-12T15:32:17.464Z (9 months ago)
• Language: Python
• Size: 173 KB
• Stars: 0
• Watchers: 10
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Pysaköinnin Sähköinen Asiointi API

Django API application

for [Pysäköinnin Sähköinen Asiointi](https://helsinkisolutionoffice.atlassian.net/wiki/spaces/PSA/overview)

## Running locally

⚠️ ️Requires a `config.env` file to run, contact admin if needed and remember to add the file to the root of the directory.

### With Docker

1. To override production Docker-Compose settings create a `docker-compose.override.yml` to your root and insert the following to the file:

```

version: '3'

services:

  server:

    container_name: api-server

    env_file:

      - config.env

    environment:

      - DATABASE_URL=postgres://parking-user:root@api-db:5432/parking-service

    expose:

      - 8080

    depends_on:

      - db

  db:

    container_name: api-db

    image: postgres:alpine

    restart: always

    environment:

      - POSTGRES_USER=parking-user

      - POSTGRES_PASSWORD=root

      - POSTGRES_DB=parking-service

    volumes:

      - db:/var/lib/postgresql/data

    ports:

      - "5432:5432"

    expose:

      - 5432

volumes:

  db:

    driver: local

```

2. run `docker-compose up` and Docker will build PostgreSQL database and Django server instances

3. you can open `http://localhost:8080/api/v1/docs` to view the API endpoints in browser

Note that running the app with Docker proxies the application to port `8080`

### Running the application with hot-reload (recommended for active development)

1. Install a Python virtual environment of your choice (for example [venv](https://docs.python.org/3/tutorial/venv.html))

  with Python 3.x

2. In a new terminal window start a local database instance with

  `docker run --name parking-service-db -p 5432:5432 -e POSTGRES_USER=parking-user -e POSTGRES_PASSWORD=root -e POSTGRES_DB=parking-service postgres:alpine`

3. Activate virtual environment

    - if you are using venv, the command is `source [insert your venv directory name here]/bin/activate` on Mac and Unix and `[insert your venv directory name here]\Scripts\activate.bat` on Windows

    - the virtual environment can be deactivated with `deactivate`

4. Install dependencies with `pip install -r requirements.in`

5. Run migrations `python manage.py migrate`

6. Run server `python manage.py runserver`

7. you can open `http://localhost:8000/api/v1/docs` to view the API endpoints in browser

- Alternatively you can run server with `gunicorn pysakoinnin_sahk_asiointi.wsgi:application --bind 0.0.0.0:8000`

Note: psycopg2 may require a local installation of PostgreSQL. Install for macOS with Homebrew `brew install postgresql`

## Generating a new requirements.txt

- Install [pip-tools](https://github.com/jazzband/pip-tools)

- Run `pip-compile` to generate a new requirements.txt file