anikashc / shedapp Goto Github PK

ShedApp - A web application for sharing your shed tools with the community!

• About Project
• Getting Started
• Features
• Documentation
• Contributing

What is ShedApp for?
Have you ever found yourself needing to use a ladder for just one job, but you don't have one and you don't want to buy one and store it all year around! ShedApp lets you borrow (or lend) shed tools with your fellow community!

How is it built?
ShedApp is built using the following frameworks and tools:

• Docker
• MySQL
• NodeJS
• Express
• React

This application has been packaged using Docker!
To get started simply:

1. Install Docker
2. Git Clone this repository:
   git clone https://github.com/JBetts97/ShedApp.git
3. Navigate to the root folder of repository and run the docker-compose command:
   docker-compose up

[X] Register and login to the service
[X] View items available to borrow
[X] List your item for other people to view
[] See where users sheds are in map view
[] Ability to remove your listing
[] Many more to come in future!

// TODO

Contributions are highly encouraged, no matter how big or small.
Refer to CONTRIBUTING.md for more details.