diff --git a/README.md b/README.md index fb0e9a079ca11b5201f6c9491c88c737778f4859..c515f2f08a400b0943263711e4e01f4610928ca1 100644 --- a/README.md +++ b/README.md @@ -9,14 +9,22 @@ This project is based on a swagger-enabled Flask server using an *API First* app ## Requirements Python 3.7+ +MariaDB (or similar Database) -## Getting started +# Setup Install the required dependencies: +```bash +pip3 install -r requirements.txt +# Additional requirements for the chosen database +pip3 install -r contrib/mariadb-requirements.txt +# Create database and user (change password in script) +sudo mysql -u root -p < contrib/mariadb-database.sql + + ``` -pip install -r requirements.txt -``` +## Getting started To run the server, please execute the following from the root directory: diff --git a/contrib/mariadb-database.sql b/contrib/mariadb-database.sql new file mode 100644 index 0000000000000000000000000000000000000000..20b84120fdaf02430aedfc52810915109000cab1 --- /dev/null +++ b/contrib/mariadb-database.sql @@ -0,0 +1,4 @@ +CREATE DATABASE aura_engine_api CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; +CREATE USER 'aura_engine_api'@'localhost' IDENTIFIED BY '1234'; +GRANT ALL PRIVILEGES ON aura_engine_api.* TO 'aura_engine_api'@'localhost'; +FLUSH PRIVILEGES; \ No newline at end of file diff --git a/contrib/mariadb-requirements.txt b/contrib/mariadb-requirements.txt new file mode 100644 index 0000000000000000000000000000000000000000..ccd50492e2b2b7fc4a290ff6cf481069e143545b --- /dev/null +++ b/contrib/mariadb-requirements.txt @@ -0,0 +1 @@ +mysqlclient==1.3.12 \ No newline at end of file