Skip to content

Latest commit

 

History

History
71 lines (51 loc) · 2.83 KB

README.md

File metadata and controls

71 lines (51 loc) · 2.83 KB

Logo


ShareStuff - A Rent And Let Communtiy Platform

Homescreen Preview Gif

ShareStuff is a free to use platform to rent and let retail items. Registered users are able to search for retail items to rent anywhere in the world. They are also able to offer their own retail items for rent. Transactions are completed via chat after booking an item. ShareStuff will not be taking part in the facilitation of transactions between users at this point.

This SPA is build with the MERN Stack. If any of you guys want to fork this project to build something similar or just need parts of it feel free to do so. 👍

Contents 📁

Features 💎

  • Working and customizable rent and let platform
  • Users can rent retail products from other users
  • Users can rent retail products to other users
  • Frontend was built with React and Material-UI
  • Backend was built with Express
  • Backend was setup to use MongoDB Atlas cloud storage
  • Database queries are facilitated with Mongoose

Setup 🔧

# clone the repositiory with git or github CLI
$ git clone https://github.com/Zuckerwattederivat/sharestuff.git
$ gh repo clone Zuckerwattederivat/sharestuff

# install dependencies server
$ cd sharestuff
$ npm install

# install dependencies client
$ cd sharestuff
$ npm run clientinstall

# connect your db and add jwt secret
$ cd sharestuff/config
$ open default.json
-> add your MongoDB Atlas database cluster link to "mongoURI"
-> add your random JSON Webtoken secret

# Geocode API Key from geocodeapi.com is needed for search functionality
$ cd sharestuff/client
$ touch .env.local
$ code .env.local
-> add REACT_APP_GEOCODE_API_KEY=<Your API Key>

# launch client and server in dev mode
$ cd sharestuff
$ npm run dev

Support 🚑

Use the issue ticker to submit bugs or requests. 😊
If you want to contribute to this project you are very welcome to do so. :octocat: 🤘

License 📜

This project is licensed under the MIT license.