OBJNULL/StockMAPI
1
0
Fork 0
generated from OBJNULL/Dockerized-Rust
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
Maddox Werts 2025-02-11 12:01:46 -05:00
parent 82f698a074
commit 053ab96323
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -12,12 +12,12 @@ In order to avoid paying **$49.99** A MONTH, this project uses **2 Free APIs** *
API Keys and Limits are setup in this project, so feel free to give it to whoever you want. As a suggestion, to create an API key, run the following command to generate one to insert into the *Database*: `openssl rand -base64 24` API Keys and Limits are setup in this project, so feel free to give it to whoever you want. As a suggestion, to create an API key, run the following command to generate one to insert into the *Database*: `openssl rand -base64 24`
## Deploying ## Deploying
This project has a [Docker Image](https://git.objnull.net/NeurontalTeam/-/packages/container/neurostock/latest) available on OBJNULL's Foragejo. However, to make things super simple, I have provided a **Docker-Compose** file for easy and reproducable deployment. This project has a [Docker Image](https://git.objnull.net/NeurontalTeam/-/packages/container/stockmapi/latest) available on OBJNULL's Foragejo. However, to make things super simple, I have provided a **Docker-Compose** file for easy and reproducable deployment.
First, create a server to store *NeuroStock* on. Run the following commands: First, create a server to store *StockMAPI* on. Run the following commands:
```bash ```bash
wget https://git.objnull.net/NeurontalTeam/NeuroStock/src/branch/main/docker-compose.yml -O ~/docker-compose.yml wget https://git.objnull.net/NeurontalTeam/StockMAPI/src/branch/main/docker-compose.yml -O ~/docker-compose.yml
wget https://git.objnull.net/NeurontalTeam/NeuroStock/src/branch/main/data/settings.yaml.template -O /srv/conf/settings.yaml wget https://git.objnull.net/NeurontalTeam/StockMAPI/src/branch/main/data/settings.yaml.template -O /srv/conf/settings.yaml
``` ```
Next, change the Docker-Compose to point towards the **/srv/conf** directory. Inside of that directory, edit the lines that you need to grab API Keys, Update the Database Password, etc. Next, change the Docker-Compose to point towards the **/srv/conf** directory. Inside of that directory, edit the lines that you need to grab API Keys, Update the Database Password, etc.
@ -31,5 +31,5 @@ docker-compose up -d
Usage is extremely simple. Just follow the format below and you should be set! Make sure to use the API Key from your provider and ask them to track symbols *(Stocks)* that you want! Usage is extremely simple. Just follow the format below and you should be set! Make sure to use the API Key from your provider and ask them to track symbols *(Stocks)* that you want!
```bash ```bash
curl 'https://www.neurostock.site/v1?api=[CHANGEME]&symbol=[CHANGEME]' curl 'https://www.stockmapi.site/v1?api=[CHANGEME]&symbol=[CHANGEME]'
``` ```