chuyinghe / apbackend

Run APBackend locally

Install depedencies

pip install -r requirements.txt

Setup database (Homebrew installation required)

brew install postgresql

Run the app

uvicorn main:app --reload

---

Run APBackend on Docker

1. Start Docker daemon
2. [Optional] Provide permission for the first run:

sudo chmod 755 docker-build.sh
sudo chmod 755 docker-run.sh

3. From the root directory, run the following cmds:

. ./scripts/build.sh
. ./scripts/run.sh

---

Result

in Browser

http://0.0.0.0:4000/api/docs Default docu generated by FastAPI

with postman

---

Architecture

Detail explanation sees Explicit Architecture. App uses onion architecture that leverages Inversion of Control. core/ knows nothing but itself; infrastructure/ has access to itself and everything in core/; presentation/ knows everything in the app.

core <-- infrastructure <-- presentation

The directory tree looks like this:

app/
├── core/
├── infrastructure/
└── presentation/

core/

This part includes the main Business Logic of the app, which actually do the work.

app/
├── core/
        ├── abstractions/
        ├── domain/
        └── services/
...

infrastructure/

This part connects the core/ to other tools like Database, search engine, or other third party APIs.

app/
├── core/
├── infrastructure/
        ├── adapters/
        └── database/
...

presentation/

This part is responsible to communicate with external world, receiving or sending infos.

app/
├── core/
├── infrastructure/
└── presentation/
        └── api/