{"id":20636362,"url":"https://github.com/amraneze/spideo-challenge","last_synced_at":"2026-04-10T11:31:44.573Z","repository":{"id":176601349,"uuid":"219210568","full_name":"Amraneze/spideo-challenge","owner":"Amraneze","description":"A challenge that I was asked to do to display my skills in Java. Challenge accepted as Barney (HIMYM) will say.","archived":false,"fork":false,"pushed_at":"2024-08-26T16:34:36.000Z","size":134,"stargazers_count":1,"open_issues_count":3,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-16T08:37:17.006Z","etag":null,"topics":["circleci","docker","docker-compose","jackson","java-8","lombok","maven","spring-boot","swagger"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Amraneze.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-02T20:33:54.000Z","updated_at":"2022-01-25T14:42:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"6fd1e322-c443-4b2c-94e7-dcbb49baed95","html_url":"https://github.com/Amraneze/spideo-challenge","commit_stats":null,"previous_names":["amraneze/spideo-challenge"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Amraneze/spideo-challenge","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Amraneze%2Fspideo-challenge","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Amraneze%2Fspideo-challenge/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Amraneze%2Fspideo-challenge/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Amraneze%2Fspideo-challenge/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Amraneze","download_url":"https://codeload.github.com/Amraneze/spideo-challenge/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Amraneze%2Fspideo-challenge/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31641114,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-10T07:40:12.752Z","status":"ssl_error","status_checked_at":"2026-04-10T07:40:11.664Z","response_time":98,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["circleci","docker","docker-compose","jackson","java-8","lombok","maven","spring-boot","swagger"],"created_at":"2024-11-16T15:10:35.399Z","updated_at":"2026-04-10T11:31:44.560Z","avatar_url":"https://github.com/Amraneze.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spideo Java Challenge - Auction House\n\n[![CircleCI](https://circleci.com/gh/Amraneze/spideo-challenge/tree/master.svg?style=svg)](https://circleci.com/gh/Amraneze/spideo-challenge/tree/master)\n\nA java challenge sent by Spideo's Team which is about creating an REST API that manages an auction house.\u003cbr\u003eThe main functionnalities of this application are :\n  \n* Create/List/Delete an(all) auction(s) house.\n* Create/List/Delete an(all) auction(s) of a specific auction house.\n* Bid in an auction and display the winner of an auction.\n\n## Getting Started\n\n### Prerequisites\n\nThis section describes the requirements to run the application\n\n##### Setup Environments\n\n* Memory: At least 2GB\n* Operating System: Linux kernel version 3.10 or higher, Windows x Pro/Ent x64.\n* Disk Space: 2GB of available disk space.\n\n\u003e NOTE: You may find all the details in the following page [Docker System requirements](https://docs.docker.com/datacenter/ucp/1.1/installation/system-requirements/)\n\n##### Install Docker\n\nIt's preferred to use Docker to test this solution, otherwise you can just install JRE and run the project with command lines\n\nThis workshop is tested with Docker Community Edition `19.03.4, build 9013bf583a` on Ubuntu 18.04.3 LTS (GNU/Linux 4.15.0-1051-aws x86_64) in AWS.\n\n##### Download Images\nThis project uses the OpenJDK docker image from [openjdk:10](https://hub.docker.com/_/openjdk)\n\n##### Other Software\n\nThe software used to create this application. Feel free to download them if you do not have them\n\n* Install [Docker](https://docs.docker.com/install/)\n(Optional) Install Docker Cloud CLI following the [instructions](https://docs.docker.com/docker-cloud/installing-cli/).\n* Install [Docker Compose](https://docs.docker.com/compose/) if you want to use docker compose.\n* Download [Maven](https://maven.apache.org/download.cgi) and install it.\n* Download your Java IDE (IntelliJ, Eclipse, Visual Studio, NetBeans ...).\n* Download the JDK [JDK 8](https://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html).\n(if you are not using Docker, and for Unix Based OS you should download OpenJDK from the OS repository)\n* After installing JDK, you should set the path variable in your OS's environment.\n* Download [Lombok](https://projectlombok.org/download) or install it from the plugins in IntelliJ if you want to work with the project's code.\n\u003e NOTE: We are using Spring Boot, so you do not have to install any server (Tomcat, GlassFich, Weblogic, JBoss...) it is already in embedded in Spring Boot.\n\n### Installing \u0026 Running\n\nAfter installing all software that you need for this project and setting up paths for Java and Maven in your OS's environment\n\n#### With Maven \nYou should run the following command to install the libraries needed. For that you should run this in your shell/Powershell\n```\nmvnw clean install\n```\nAfter this, you can run the application with this command\n```\nmvnw spring-boot:run\n```\nOr you can build the jar with this command\n```\nmvnw package \n```\nAnd then \n```\njava -jar target/test-0.0.1-SNAPSHOT.jar\n```\n\u003eNOTE: You should be in the root folder of the project where you can see the folders **src, docs and other files**\n\n#### With Docker\n\nYou should build the jar before starting the build the docker image, for that you should use this command\n```\nmvnw package\n```\nAfter checking if the jar is built in the target folder, you may use this following command\n```\ndocker build -t test:latest .\n```\nThen, you should make sure the image is created using\n```\ndocker images\n```\n##### With Docker\nAnd finally, you can run the image and expose the port that you need instead of **xxxx** \n```\ndocker run -p xxxx:8080 test\n```\n\n##### With Docker Compose\nAnd finally, you can use docker-compose that it will run the image and also check its health\n```\ndocker-compose up\n```\n\n\u003eNOTE: The port exposed in Docker image is 8080, which can be changed in Dockerfile, if you need to. Otherwise, you can just change the port that you want in **xxxx** without modifying the image\n\n**You can also test using my Docker image that is running on an [AWS instance](http://13.48.136.181:8080/api/)**\n\n### Running the tests\n\nFor running the tests, you should run this maven command\n* Using a Unix based OS: \n```\nmvn test\n```\n* Using a Windows OS:\n```\nmvnw test\n```\n\n## Endpoints\n\n\u003eNOTE: Content-Type: ``application/json`` header must be present in each request to use the API.\n\n### Swagger\n\nFor visualizing the detailed documentation about the API, please refer to the [Project's Swagger Page](http://13.48.136.181:8080/api/swagger-ui.html#/auction-house-controller)\n\n## Built With\n\n* [Spring-Boot](https://spring.io/projects/spring-boot) - The web framework used\n* [Maven](https://maven.apache.org/) - Dependency Management\n* [Lombok](https://projectlombok.org/) - Library that makes the code cleaner with less efforts\n* [Swagger](https://swagger.io/tools/swagger-ui/) - Library to visual the API's endpoints\n* [With Love](https://github.com/Amraneze) - With love from Paris\n\n## License\n\nThis project is licensed under the GNU GPLv3 - see the [LICENSE.md](LICENSE.md) file for details","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famraneze%2Fspideo-challenge","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Famraneze%2Fspideo-challenge","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Famraneze%2Fspideo-challenge/lists"}