d3strukt0r/fhnw-stocks-tracker-api repository overview

⁠fhnw-stocks-tracker

Tracks stocks owned on different platforms

Project

master-branch (alias stable, latest)

develop-branch (alias nightly)

⁠Getting Started (Development)

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

git clone https://github.com/FHNW-Dream-Team/stocks-tracker.git

Please further read on the wiki⁠.

⁠Getting Started (Production)

In order to run this container you'll need docker installed.

• Windows⁠
• OS X⁠
• Linux⁠

⁠Usage of Docker images

⁠Container Parameters

docker run \
    -p 8080:8080
    -e <all the keys>
    d3strukt0r/fhnw-stocks-tracker-client

docker run \
    -p 80:80
    d3strukt0r/fhnw-stocks-tracker-api

For a full example with Docker Compose please check the wiki⁠.

⁠Environment Variables

All environment variables support Docker Secrets. To learn more about Docker Secrets, read here⁠.

Basically, after creating a secret, append a _FILE (e. g. DB_PASSWORD_FILE) after the environment variable and set the path to something like /run/secrets/<something>.

⁠API Envs

• SPRING_APPLICATION_JSON - Configuration to pass to spring boot (JSON)

⁠Client Envs

• NGINX_CLIENT_MAX_BODY_SIZE - The maximum size for sending POST requests (maximum upload size) (has to be the same on php) (Default: 100M)
• USE_HTTPS - Enables https. (Not recommeded, rather use Traefik) (Default: false)

⁠Volumes

• /app - Where the app is stored

⁠Built With

• JavaScript⁠ - Programming language
• Bootstrap⁠ - Frontend framework
• SB Admin 2⁠ - Theme for client
• Java⁠ - Programming language
• Spring Boot⁠ - Java web framework
• Github Actions⁠ - Automatic CI (Testing) / CD (Deployment)
• Docker⁠ - Containerized image

⁠Contributing

Please read CONTRIBUTING.md⁠ for details on our code of conduct, and the process for submitting pull requests to us.

⁠Versioning

We use SemVer⁠ for versioning. For the versions available, see the tags on this repository⁠.

⁠Authors

• Manuele Vaccari - D3strukt0r⁠ - Initial work, Setup client, Create stocks, Edit stocks
• Victor Hargrave - jokerengine⁠ - Setup backend, Register, Detail stock
• Sasa Trajkova - sasatrajkova⁠ - Stocks overview, Edit profile, Delete stock
• Thomas Weber - tjw52⁠ - Login, Logout, CRUD Currency

See also the list of contributors⁠ who participated in this project.

⁠License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE.txt⁠ file for details.

⁠Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc