Skip to content

Latest commit

 

History

History
66 lines (51 loc) · 1.96 KB

README.md

File metadata and controls

66 lines (51 loc) · 1.96 KB
Raw

FunToPlan

FunToPlan is an interactive application designed to make event planning fun, simple, and effective!

Key Features

  • 🎉 User-friendly interface for personalized event planning.
  • 🗺️ Map integration for location-based event planning.
  • 🔒 Secure authentication and session management.
  • 📧 Email notifications using SendGrid and Nodemailer.
  • 🛠️ Easy-to-use tools for managing participants and tasks.

Installation and Setup

System Requirements

  • Node.js version 16 or higher
  • npm (Node.js package manager)

Installation Instructions

  1. Clone the repository to your local machine: 
    git clone https://github.com/hadassaBrad/fun_to_plan.git
  2. Install the dependencies: 
    cd fun_to_plan
npm install

Running the Application

  1. Start the development server: 
    npm run dev
  2. Open your browser at: http://localhost:3000

Technologies Used

  • Node.js: Backend runtime environment.
  • Express.js: Framework for handling routes and API endpoints.
  • MySQL: Additional database support for relational data.
  • React (with React Router): Frontend framework for creating interactive user interfaces.
  • Leaflet and React-Leaflet: For interactive maps and geolocation features.
  • SendGrid and Nodemailer: For sending email notifications.
  • jsonwebtoken: For secure authentication and token management.
  • bcrypt: For password hashing and security.
  • dotenv: For managing environment variables.

Contributing

We welcome ideas and collaborations!

  1. Open an Issue for bugs or feature requests.
  2. Submit a Pull Request to improve the codebase.

License

This project is licensed under the ISC License.

Contact

For additional questions or collaborations, feel free to reach out via GitHub: Hadassa Bradpiece or GitHub: Ruchama Bricker.