Skip to content

Rudronha/Share-Essentials

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

13 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Item Sharing and Marketplace Platform

Overview

This project is a full-stack application built using React, Express.js, and MySQL. It allows users to share items, rent them, buy and sell essential items as needed.

Features

  • User registration and authentication
  • Item listing for sharing, renting, buying, and selling
  • Search and filter functionality
  • User profiles with item management
  • Secure transactions and communications

Tech Stack

  • Frontend: React.js
  • Backend: Express.js
  • Database: MySQL

Installation

Prerequisites

  • Node.js
  • MySQL

Steps

  1. Clone the repository:
    git clone https://github.com/your-username/your-repo.git
    cd your-repo
  2. Install backend dependencies
    cd server
    npm install
    
  3. Install frontend dependencies
     cd ../client
     npm install
  4. Create a database in MySQL:
    CREATE DATABASE your_database_name;
    
  5. Update database configuration in backend/config/db.js:
    module.exports = {
     host: 'localhost',
     user: 'your_username',
     password: 'your_password',
     database: 'your_database_name',
     };
  6. Start the server and client:
    cd backend
     npm start
    cd backend
     npm start

#Folder Structure

     your-repo/
     β”œβ”€β”€ backend/
     β”‚   β”œβ”€β”€ config/
     β”‚   β”‚   └── db.js
     β”‚   β”œβ”€β”€ controllers/
     β”‚   β”œβ”€β”€ models/
     β”‚   β”œβ”€β”€ routes/
     β”‚   β”œβ”€β”€ app.js
     β”‚   └── package.json
     └── frontend/
         β”œβ”€β”€ src/
         β”‚   β”œβ”€β”€ components/
         β”‚   β”œβ”€β”€ pages/
         β”‚   β”œβ”€β”€ App.js
         β”‚   └── index.js
         └── package.json


### Instructions:
1. Replace `https://github.com/your-username/your-repo.git` with the actual URL of your repository.
2. Update `your_username`, `your_password`, and `your_database_name` with your MySQL credentials and database name.
3. Update `your-email@example.com` with your actual contact email.

This README file includes an overview, features, tech stack, installation steps, usage instructions, folder structure, contribution guidelines, license information, and contact details. Adjust the content as needed to fit your project's specifics.

## License

This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published