Skip to content

Latest commit

 

History

History
114 lines (78 loc) · 3.68 KB

README.md

File metadata and controls

114 lines (78 loc) · 3.68 KB
Raw

Logo

Auction App

Auction App is a fullstack web application for online auctions.

Table of Contents
  1. Technology Stack
  2. Getting Started
  3. Deployment
  4. Contact

Technology Stack

Frontend

Technologies used:

  • ReactJS
  • Sass

Backend

Technologies used:

  • Java
  • Spring Boot
  • PostgreSQL

Getting Started

Frontend Prerequisites

In order the run the frontend part of the application you will need to have Node JS installed.

To start the app, in the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in your browser.

In order to use the image upload services you will need to have a valid Imgur Client-ID. To get a Client-ID you will need to register your app. You can do so by following these instructions. After you have your Client-ID, you can than run the app like this:

REACT_APP_IMGUR_API_KEY=<YOUR CLIENT-ID> npm start

Or you can set the REACT_APP_IMGUR_API_KEY environment variable.

Backend Prerequisites

In order to run the Spring Boot application you will need to setup PostgreSQL in your system. If you aren't already familiar with PostgreSQL, you can refer to this link to get started.

After PostgreSQL is setup correctly, you will need to create a database with the name auctionapp, so the application can connect to it.

To run the app you can either use Maven or start the app from your code editor. For development IntelliJ IDEA code editor was used.

If Maven is setup on your system, in the project root directory run the command:

mvn spring-boot:run

If everything went well the server should start and the connection to the database should be established.

To check available routes open http://localhost:8080/swagger-ui/

Deployment

Heroku is used for application deployment.

Frontend Application

Frontend ReactJS application is deployed at https://auction-app-1.herokuapp.com/.

Backend Application

Backend Spring Boot application is deployed at https://auction-api-1.herokuapp.com/.

Contact

Ajdin Becirovic - @Ajdin Becirovic - [email protected]