Sports-Hub Application Rust Back-End

Project Description

This is a draft pet project for testing Generative AI on different software engineering tasks. It is planned to evolve and grow over time. Specifically, this repo will be a Rust playground.

The application's legend is based on the sports-hub application description from the following repo: Sports-Hub.

Available Front-End applications

• React.js
• Angular

Dependencies

• Docker
• Docker Compose

The mentioned dependencies can be installed using the official documentation here. Read more about alternatives to Docker here.

Setup and Running the Application

Clone the Repositories

To run the web application with the React front-end, clone the following repositories within the same folder:

git clone git@github.com:dark-side/sports_hub_rust_skeleton.git
git clone git@github.com:dark-side/sports_hub_react_skeleton.git
git clone git@github.com:dark-side/api_docs_genai_playground.git

Navigate to the back-end application directory

All commands should be run from the sports_hub_rust_skeleton directory.

Create .env File

Copy the .env.example file to .env in the root of the project directory:

cp .env.example .env

Update the .env file with your local development credentials and secrets. Make sure not to commit this .env file to version control.

Run Docker Compose

Navigate to the back-end application directory and run (-d for detached mode to run in the background):

docker compose up -d

Attach to the Backend Container (Optionally)

Run docker ps and copy the backend application container ID. Then, connect to the container with the following command:

docker exec -ti <CONTAINER ID> /bin/bash

or just use the container name, e.g.:

docker exec -ti rust-backend /bin/bash

Accessing the Application

To access the application in a browser locally, open the following URL:

• Mac, Linux - http://localhost:3000/
• Windows - http://127.0.0.1:3000/

Testing the Application

To run the tests, make sure you are in the sports_hub_rust_skeleton/backend directory and execute:

cargo test

Additionally, you can test the API endpoints using provided 'curl'-based script API_Testing_Guide.md or with Postman.

Stopping the Application

To stop the application and remove the containers, run:

docker compose down

License

Licensed under either of

• Apache License, Version 2.0
• MIT license

Just to let you know, at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in your work, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Should you have any suggestions, please create an Issue for this repository