ACME RUN

Welcome to our implementation of ACME RUN. Please refer to the provided case study and design documentation for more details.

Getting Started

Follow these steps to get started:

1. Clone the Repository:

git clone https://github.com/CAS735-F23/macrun-teamvsl.git
cd macrun-teamvsl

2. Import Postman Collection:

• Import the provided Postman Collection from the repository into your Postman workspace or use this link.
• The collection includes predefined API requests for ACME RUN.
• The collection is divided into 9 folders, the first for initializing the application and the others for the different scenarios. Each folder has its description explaining what it does.
• All the folders and APIs are ordered to be run from top to bottom. We recommend you to run each API one by one while simultaneously seeing the logs in the terminal.

3. Run Docker Compose

docker compose up

• This will run the tests and start the services.
• It starts by running the tests. For additional information about the tests, refer to the test description here.
• Once the tests are done, it will start the services.
• Services use ports 8010 to 8014 and 5432 (for PostgreSQL) by default; ensure they are available for API functionality.

4. Run APIs:

• Execute the API requests from the top of the Postman Collection.
• Explore and interact with the various endpoints available in ACME RUN.

Contributors

• Liuyin Shi ([email protected])
• Samkith K Jain ([email protected])
• Varun Rajput ([email protected])