KSCIA BACKEND

KSCIA backend server to provide APIs and services
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contact

About The Project

While there are websites dedicated to individuals with spinal cord injuries, there seemed to be a noticeable absence of mobile applications catering to their specific needs. Recognizing the physical challenges these individuals face, we believed that an easily accessible and user-friendly app was essential. Our goal was to provide on-the-go support and help foster a sense of community. Thus, we embarked on the development of a "Lifestyle App for Individuals with Spinal Cord Injuries". This app was crafted using the cross-platform framework, Flutter, ensuring compatibility with both Android and iOS devices. The backend, which provides the API, was developed using FastAPI.

Features include:

• A direct link to the Spinal Cord Injury Association website.
• A real-time chat system for counseling.
• Health and hygiene programs and checklists.

Through this app, we hope to simplify access to the services provided to individuals with spinal cord injuries, potentially enhancing their quality of life.

The current repository focuses on the backend component.

(back to top)

Built With

This section lists major frameworks/systems used to this project.

• 
• 
• 

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• bash

  sudo add-apt-repository ppa:deadsnakes/ppa
  sudo apt-get update

  sudo apt install python3.10
  sudo apt-get install mysql-server
  sudo apt-get install redis-server

• mysql

  CREATE DATABASE kscia;
  CREATE USER userid@localhost IDENTIFIED BY 'password';
  GRANT ALL privileges ON kscia.* TO userid@locahost IDENTIFIED BY 'password';
  FLUSH privileges;

Installation

Below is an example of how you can install and set up your app.

1. Clone the repo

   git clone https://github.com/79841/kscia-back.git

2. Start virtual environment

   python3.10 -m venv .venv
   source .venv/bin/activate

3. Install PIP packages

   pip intall -r requirements.txt

4. Enter your API in .env

   DATABASE_URL=mysql+pymysql://userid:password@127.0.0.1:3306/kscia?charset=utf8
   ASYNC_DATABASE_URL=mysql+aiomysql://userid:password@127.0.0.1:3306/kscia?charset=utf8
   PROFILE_IMAGE_DIR=images/profile
   

5. Start server

   python main.py

6. Test

   It is the process of adding the test dataset to the database.

   cd ./test
   python test.py

(back to top)

Usage

Please refer to the Documentation

(back to top)

Contact

Letmedev - 79841@naver.com

Project Link: https://github.com/79841/kscia-back

(back to top)