Git Repo Setup

Quickstart: snapcaster-backend

Follow these steps to quickly get the snapcaster-backend repo up and running:

Clone the Repo

Clone the repository: First, clone the backend repository to your local machine.

For Linux and MacOS users
```
git clone https://github.com/bryceeppler/snapcaster-backend.git
```
For Windows users (Otherwise will get Docker errors due to new line character interpretation)
```
git clone --config core.autocrlf=false https://github.com/bryceeppler/snapcaster-backend.git
```
Navigate to the project folder:
```
cd snapcaster-backend
```
Set your enviornment variables: Refer to the Enviornment Variable Setup section.
Start the application: Use docker-compose to build and launch all the necessary services.
```
docker-compose up --build -d
```
Run your containers: You can run all your containers in Docker Desktop. Make sure you don’t have any conflicting ports open that might prevent a container microservice from working.
Setup rabbit mq (Used for scrapers)
```
docker pull rabbitmq:3-management
```
```
docker run -d --name rabbitmq -p 5672:5672 -p 15672:15672 rabbitmq:3-management
```
open http://localhost:15672/ and enter the username “guest” password “guest”
Use the endpoints: You can now use Snapcaster, here are the main endpoints:
- /search for individual card price searches (catalog service)
- /search_multiple for multi card bulk price searches (catalog service)
- /advanced for advanced card price searches (search service) (Integrating into catalog service soon)
- /websites for retrieving website meta data used by the front end (search service)

Build & Deploy

Do not deploy anything without it being merged in main and having it approved. Using the deploy_docker.sh file in the root directory:

Run bash deploy_docker.sh with no arguments to make sure you’re familiar with the function signature order.
Format bash deploy_docker.sh <Version> <RegistryURL> <ServiceName> The Service Name can be the a specific service or you can input all to loop through all services (not reccomended)
Each Microservice and Cron job in railway is connected to the source image through DockerHub.

Quickstart: snapcaster-client

Clone the Repo

Follow these steps to quickly get the snapcaster-backend repo up and running:

Clone the repository: First, clone the front end repository to your local machine.
```
git clone https://github.com/bryceeppler/snapcaster-client.git
```
Navigate to the project folder:
```
cd snapcaster-client
```
Install your dependencies:
```
pnpm i
```
Set your enviornment variables: Refer to the Enviornment Variable Setup section.
Start your application:
```
pnpm run dev
```

Quickstart: snapcaster-analytics

Clone the Repo

Follow these steps to quickly get the snapcaster-analytics repo up and running:

Clone the repository: First, clone the front end repository to your local machine.
```
git clone https://github.com/bryceeppler/snapcaster-analytics.git
```
Navigate to the project folder:
```
cd snapcaster-client
```
Install your dependencies:
```
pnpm i
```
Set your enviornment variables: Refer to the Enviornment Variable Setup section.
Start your application:
```
pnpm run dev
```