Skip to content

Latest commit

 

History

History
79 lines (56 loc) · 1.76 KB

README.md

File metadata and controls

79 lines (56 loc) · 1.76 KB

bexh-api-aws-lambda

Project setup:

Virtual environment setup:

pip3 install pipenv
pipenv shell --python 3.8

Install pipfile libraries:

make install-dev

Set up interpreter:

1. Go to PyCharm > Settings > Project:bexh-api-aws-lambda > Project Interpreter

2. Select ... to the right of the option and select add...

3. Select existing environment

4. Select the python file as per your virtual environment which can be found in terminal using:
    
    which python

5. Apply, OK

Configure Local Infra

Set up mysql and aws localstack containers and set up db tables:

make docker-up
make local-setup

Configuring .env File

1. Go to Preferences > Plugins andinstall the EnvFile plugin

2. Restart PyCharm

Running the Project

1. Open /service.py and hit the play button on the left hand side which will
use /event.json as the event to your function

2. Double check that working directory is set to your path to bexh-api-aws-lambda

2. At the top right of the screen, drop down the service python configuration
and select "edit configurations..."

3. Select the EnvFile tab at the top, enable EnvFile, add new env file, and select .env

4. Apply, OK

Configuring new routes

Locate the examples in /controllers.py

Help

Make Targets:

Commands:
    clean          Cleans venv and package from old builds
    build          Bundle package for deployment
    test           Runs all test cases
    install        Installs pipfile libraries
    install-dev    Installs pipfile libraries for development purposes
    docker-up      Spins up localstack and mysql containers for local development
    docker-down    Spins down containers for local development
    local-setup    Creates a mysql instance and creates tables