Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
engine-api
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
AURA
engine-api
Commits
74af0a7b
Commit
74af0a7b
authored
4 years ago
by
David Trattnig
Browse files
Options
Downloads
Patches
Plain Diff
Removed warnings.
parent
ced63515
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+8
-8
8 additions, 8 deletions
README.md
with
8 additions
and
8 deletions
README.md
+
8
−
8
View file @
74af0a7b
...
@@ -11,7 +11,7 @@ This project is based on a swagger-enabled Flask server using an *API First* app
...
@@ -11,7 +11,7 @@ This project is based on a swagger-enabled Flask server using an *API First* app
Python 3.7+
Python 3.7+
MariaDB (or similar Database)
MariaDB (or similar Database)
#
Setup
#
#
Installation
Install the required dependencies:
Install the required dependencies:
...
@@ -21,39 +21,39 @@ pip3 install -r requirements.txt
...
@@ -21,39 +21,39 @@ pip3 install -r requirements.txt
pip3
install
-r
contrib/mariadb-requirements.txt
pip3
install
-r
contrib/mariadb-requirements.txt
# Create database and user (change password in script)
# Create database and user (change password in script)
sudo
mysql
-u
root
-p
< contrib/mariadb-database.sql
sudo
mysql
-u
root
-p
< contrib/mariadb-database.sql
```
```
## Getting started
## Getting started
To run the server, please execute the following from the root directory:
To run the server, please execute the following from the root directory:
```
```
bash
./run.sh api
./run.sh api
```
```
To run the API in an local development server execute:
To run the API in an local development server execute:
```
```
bash
./run.sh api-dev
./run.sh api-dev
```
```
You can access the interactive documentation here:
You can access the interactive documentation here:
```
```
bash
http://localhost:8008/api/v1/ui/
http://localhost:8008/api/v1/ui/
```
```
Your OpenAPI definition lives here:
Your OpenAPI definition lives here:
```
```
bash
http://localhost:8008/api/v1/openapi.json
http://localhost:8008/api/v1/openapi.json
```
```
## Testing
## Testing
To launch the integration tests, use tox:
To launch the integration tests, use tox:
```
```
bash
sudo
pip
install
tox
sudo
pip
install
tox
./run.sh
test
./run.sh
test
```
```
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment