Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fbraem authored Oct 14, 2023
1 parent b6de9bf commit 02fb701
Showing 1 changed file with 1 addition and 22 deletions.
23 changes: 1 addition & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,6 @@
# Kwai

This repository is (again) a greenfield project: a monorepo containing the source code for the frontend and
the backend of Kwai. Someday, Kwai will be a (sport) club management system.

The system is written following DDD as software development philosophy. Clean code should be the result of following
this philosophy.

## Frontend
The frontend consists of several single page applications. [Vue](https://vuejs.org) is used as JavaScript framework.

## Backend
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
![ruff](https://github.com/fbraem/kwai/actions/workflows/ruff.yml/badge.svg)

![test](https://github.com/fbraem/kwai/actions/workflows/backend_test.yml/badge.svg)
[![coverage](https://fbraem.github.io/kwai/coverage/coverage.svg)](https://fbraem.github.io/kwai/coverage/)

Unlike the [other version](https://github.com/fbraem/kwai-api) which is written in PHP, this backend is written in
Python and uses [FastAPI](https://fastapi.tiangolo.com/) as web framework to provide an API for Kwai.

For more information about the backend: [README.md](./backend)

At the moment there is no release available yet.
The code for kwai is now stored on [Codeberg](https://codeberg.org/zumuta/kwai)

## Acknowledgments

Expand Down

0 comments on commit 02fb701

Please sign in to comment.