LiXuanqi / NuaaOversea-backend-Flask

The backend for NuaaOversea - A studying aboard information sharing platform.

NuaaOversea-backend-Flask

NuaaOversea is a studying aboard information sharing platform, which collects information about the admission of students from NUAA and students' GPA, Language score(TOEFL, IELTS), GRE, etc.

Provide students with data and similar cases for reference and help them make more informed decisions.

Created with ❤️

This repository stores the code for backend. You can visit the frontend code here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

• python >=3.7.0
• docker
• docker-compose

Setup Database

we use docker to setup the MariaDB as development database. you can implement this part with any sql server. You can config the database in docker-compose.yml. In the root directory, run command as bellow.

docker-compose up -d
flask init-db

The database runs on http://localhost:3306

Run Server

You can config the server in config.py

git clone https://github.com/LiXuanqi/NuaaOversea-backend-Flask.git
cd NuaaOversee-backend-Flask
pip install -r requirements.txt
flask run

The backend server runs on http://localhost:5000

Running the tests

pytest

Built With

• Flask
• Flask-RESTful
• MariaDB

Task lists

• add unit tests, achieve >90% code coverage.
• show REST APIs using Swagger UI.

Authors

• Xuanqi Li - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE.md file for details