Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/smatiolids/astra-demo-logistics
https://github.com/smatiolids/astra-demo-logistics
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/smatiolids/astra-demo-logistics
- Owner: smatiolids
- Created: 2022-09-23T16:44:57.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-07T17:25:59.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T03:41:11.095Z (7 months ago)
- Language: JavaScript
- Size: 25.2 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Astra-demo-logistics
# Pre-requisites
You need to sign-up to (Astra)[astra.datastax.com]. With that you will have your organization ID.
You will also need a token with permissions to create all the resources.
# Provisioning Astra Resources
## Setup Terraform
Follow thw instructions at: https://www.datastax.com/blog/let-s-get-started-with-terraform-for-astra-db
## Run Terraform to provision environment
To provision the database and streaming tenant, you can use terraform.
Create a file to set the variables at the terraform folder with the following content.
E.g.: terraform/myenv.tfvars.json
````
{
"ASTRA_ORG_ID": "",
"ASTRA_TOKEN": ""
}
````
Validate the terraform script with the planning option
`````
terraform plan -var-file="myenv.tfvars.json"
`````
If everything runs fine, you can apply the script to provision the environment
`````
terraform apply -var-file="myenv.tfvars.json"
`````
Some important outputs from the terraform execution are important to set the environment variables in the next step.
# Running the application
## Set Environment Variables
Copy the .env_sample to .env and define your local variables
## Run Docker Containers
At the project root folder, run:
```
docker-compose up
```
## Producing messages
All the messages can be triggered via APIs.
- GET /ping
- Endpoint to troubleshoot communication with the backend. If it responds, communictaion is ok
- GET /files
- Returns all files uplaoded and available at the tmp folder to be produced
- POST /upload
- Upload multiple files to be produced
- DELETE /files
- Delete all the files in the tmp folder.
- POST /produce
- Starts the producers for all files. Messages are sent with a 3 second interval.
- POST /produce-file
- Start the producer for the specified file
> You can import the file "DataStax Logistics Demo.postman_collection.json" in Postman to interact with the backend
### Attention
Once the producer is triggered, it is not possible to stop it. If needed, stop the container and then clean the data.
## How to generate path files
- Go to the url https://www.keene.edu/campus/maps/tool/[https://www.keene.edu/campus/maps/tool/] and create a path.
- Copy the lat-long part separated by comma to a file with the following pattern --.txt
- The producer will send a line every 3 seconds with the current timestamp.
# Developing the Frontend WebApp
To run the frontend locally for development purposes follow the instructions:
Built on react-admin (https://marmelab.com/react-admin/).
The data provider is adapted to woth with Astra Stargate.
ATTENTION: Variables for the React App have to be defined in the .env file inside the "/frontend" folder
To run, just use the following command:
```
cd frontend
npm install
npm start
```