Skip to content

FranciscoNMora/LemonsMarket

Repository files navigation

Lemons.Market Application

API for creating stock orders

Small scale API to support an image sharing application.

API requirements: /orders/ endpoint, primarily requestable through Post request, using those fields (snake_case or CamelCase open to you):

i. isin (String, 12 chars (this identifies a stock))
ii. limit_price (Float, always >0)
iii. side (Enum: buy | sell, case sensitive tolerant)
iv. valid_until (Integer, Unix UTC Timestamp)
v. quantity (Integer, always >0)

User Manual

Clone repository (assumes that docker-compose is installed)

git clone https://github.com/FranciscoNMora/LemonsMarket.git

Move to folder

cd LemonsMarket

Built and deploy containers (assume that docker-compose is installed):

docker-compose up -d --build

Admin

The user can access to the admin site (http://127.0.0.1:8000/admin/) using the superuser credentials indicated in the .env.sample file (user/password by default)

API Documentation

The documentation of the API is available in the following URLs. The API can be tested here:

-http://127.0.0.1:8000/doc/swagger/ : SwaggerUI documentation

To create orders using the API, it is necessary for the DB to have some Stocks stored (the order is associated to a Stock). Stocks can be created using the admin interface (/admin/), accessing using your superuser credentials, or using the /stock/ API (also available in Swagger)

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published