Hammer-Hub is a full-stack web application for online auctions. It utilizes a Node.js/Express backend with a React frontend, all containerized using Docker for easy setup and deployment. This application allows users to view auctions, place bids, and add new auctions.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
What things you need to install the software and how to install them:
A step by step series of examples that tell you how to get a development environment running:
-
Clone the repository
git clone https://github.com/yourusername/hammer-hub.git cd hammer-hub -
Set up the backend
Navigate to the
backenddirectory and install dependencies:cd backend npm install -
Set up the frontend
Navigate to the
frontenddirectory and install dependencies:cd ../frontend npm install -
Run the application using Docker
From the root directory of the project, run:
docker-compose up --build
This command builds and starts the containers needed for the backend, frontend, and database.
- The frontend is accessible at
http://localhost:80 - The backend API is accessible at
http://localhost:3000
Coming soon！
- React - The web framework used for the frontend.
- Node.js - Backend runtime environment.
- Express - Backend web application framework.
- MySQL - Database used for storing auction data.
- Docker - Containerization platform.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- CAO, Lisi - Initial work - lisiCAO
See also the list of contributors who participated in this project.
This project is licensed under the MIT License - see the LICENSE.md file for details
- John Abbott College