https://github.com/toghrulmirzayev/employees-api-mock

A simple app to help my students understand backend development and cover it with automated tests.
https://github.com/toghrulmirzayev/employees-api-mock

api flask mock-api

Last synced: 2 months ago
JSON representation

A simple app to help my students understand backend development and cover it with automated tests.

• Host: GitHub
• URL: https://github.com/toghrulmirzayev/employees-api-mock
• Owner: ToghrulMirzayev
• License: mit
• Created: 2023-07-26T23:22:50.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-24T21:54:50.000Z (about 1 year ago)
• Last Synced: 2024-10-12T14:14:33.833Z (3 months ago)
• Topics: api, flask, mock-api
• Language: Python
• Homepage: https://employees-api-i9ae.onrender.com/
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# employees-api

A simple app to help my students understand backend development and cover it with automated tests. \

This app is replication of employees-api, just without DB, all data will be stored inside JSON while application is running.

Application is live on https://employees-api-i9ae.onrender.com/

API specs: https://employees-api-i9ae.onrender.com/apidocs/

# Technical stack

* Python

* Flask

# Quick start

* Clone this repo to your local

* Create and activate virtual env

* Install dependencies:

  * `pip install -r requirements.txt`

* To make this code work in your local machine, create `.env` in root directory and add environment variables there as shown in below example:

```

JWT_SECRET_KEY='your secret key'

APP_SUPERUSER='your username'

APP_PASSWORD='your password'

```

* Run application using below command:

  * `python app.py`

* Run application in Docker container use below command:

  * `docker-compose up`