sneilan / stock-exchange

Personal stock exchange on your laptop!
Other
39 stars 7 forks source link

Root directory cleanup #12

Closed sneilan closed 12 months ago

sneilan commented 12 months ago

It's not clear looking at the root directory how to use the server. There's a make.sh, a run.sh, a couple cpp files, Dockerfile, Cmake These files suggest four separate workflows to the end user.

  1. Cmake -> Manual install and download libraries via source or apt.
  2. make.sh / run.sh Run these directly to get started. But they can only be ran by docker.
  3. cpp files -> Suggestive of importing into your own application
  4. Dockerfile -> Run the docker but does not describe command. Does run.sh do this?

The root directory is confusing and should be cleaned up.

sneilan commented 12 months ago

I've created a new folder called src where all source code lives. I've left the Dockerfile in the root directory. make.sh / run.sh live in a scripts/deploy directory. Finally I'm creating a docker-compose file so it's easy to run the server. No more docker run -it -v $PWD:/app -p 8888:8888 exchange and docker build whatever.