uttam-kesarwani333/remainder-mern

Full Stack Reminder App

Table of Contents

• About
• Features
• Technologies
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Contributing
• Acknowledgments

About

The Full Stack Reminder App is a web application designed to help users manage their reminders efficiently. Whether it's for personal tasks, events, or important dates, this app allows users to create, view, edit, and delete reminders easily. The app provides a user-friendly interface to interact with reminders and ensures timely notifications.

Features

• Create reminders with date and time
• Set subject, description, and contact details
• Recurrence options for periodic reminders
• View a list of all reminders
• Edit existing reminders
• Delete reminders
• Real-time notifications and reminders via Twilio
• Full-stack architecture using MERN (MongoDB, Express, React, Node.js)

Technologies

• Frontend: React, HTML, CSS
• Backend: Node.js, Express.js, MongoDB
• Database: MongoDB Atlas
• Real-time Notifications: Twilio

Getting Started

Prerequisites

Before running the project, ensure you have the following software/tools installed on your machine:

• Node.js and npm (Node Package Manager)
• MongoDB (or MongoDB Atlas)
• Git

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/full-stack-reminder-app.git

   Replace yourusername with your actual GitHub username.

2. Navigate to the project directory:

   cd full-stack-reminder-app

3. Install project dependencies:

   npm install

4. Set up your environment variables. Create a .env file in the root directory and add the following:

   ACCOUNT_SID=your_twilio_account_sid
   AUTH_TOKEN=your_twilio_auth_token

   Replace your_twilio_account_sid and your_twilio_auth_token with your actual Twilio credentials.

5. Start the development server:

   npm start

   This will start both the server and the React frontend.

Usage

1. Access the app by opening it in your web browser at http://localhost:3000.

2. Create reminders by clicking the "Create Reminder" button and filling in the details.

3. View, edit, and delete reminders as needed from the reminders list.

4. Experience real-time notifications via Twilio for your reminders.

Contributing

Contributions are welcome! Feel free to open issues or submit pull requests to help improve this project.

Acknowledgments

Special thanks to the open-source community for providing the tools and libraries that made this project possible.

Please replace `yourusername` in the clone URL with your actual GitHub username, and update the Twilio credentials in the `.env` section before pasting this content into your README.md file.