https://github.com/someengineering/fixbackend

Fix backend component
https://github.com/someengineering/fixbackend

Last synced: 9 months ago
JSON representation

Fix backend component

• Host: GitHub
• URL: https://github.com/someengineering/fixbackend
• Owner: someengineering
• License: agpl-3.0
• Created: 2023-07-25T09:42:31.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-29T10:09:37.000Z (over 1 year ago)
• Last Synced: 2024-10-29T12:13:16.113Z (over 1 year ago)
• Language: Python
• Homepage: https://fix.security
• Size: 2.51 MB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# FIX backend

Backend for fix. Contains user auth module and provides API for the SPA. 

## Installation 

### Devcontainers

Open in vscode, click run devcontainer and the project will be installed automagically.

### Local setup

1. Install Poetry

2. Install MariaDB

3. Run `poetry install` in the project folder

## Configuration

You need obtain google oauth credentials. See the instructions here: https://developers.google.com/identity/protocols/oauth2

Then make them available under `GOOGLE_OAUTH_CLIENT_ID` and `GOOGLE_OAUTH_CLIENT_SECRET` env vars.

## Run the service

Run `potery run start` to run the service. Swagger docs are available at http://127.0.0.1:8000/docs