README.md

stocker

Developing a system to manage stock trading operations, including handling of trader profiles, stock transactions, stock listings, and market staff. This system will facilitate the creation, update, retrieval, and deletion of information about traders, transactions, stocks, and market personnel.

Setup Guide:

• Clone the repository.

git clone [email protected]:2k4sm/stocker.git
cd stocker

• To use default database config(need to have provided .env file) run :

export $(cat .env | xargs)

• To use other database(use db conn string to obtain needed details) run:

provide appropriate value for < blank > fields

touch .env

# export the variables.
export DB_URL=<url>
export DB_PWD=<user-password>
export DB_UNAME=<user-name>

# Store it in .env(needed for compose to run.)
echo DB_URL=$DB_URL >> .env
echo DB_PWD=$DB_PWD >> .env
echo DB_UNAME=$DB_UNAME >> .env

export $(cat .env | xargs)

• Building the jar file run:

./mvnw clean package

• To start the server run:

java -jar ./target/stocker-0.0.1-SNAPSHOT.jar

• Stopping the server.

press : ctrl + c

---

Schema Design:

API Endpoints:

Use the swagger-Ui url to access the api endpoints and interact with the api: swagger-ui

API is deployed using Dockerfile at koyeb.

• Access the api at api-sm2k4.koyeb.app

Thanks for using stocker.