Skip to content

Vaibhav-Aditya/Sticky-DO

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 

Repository files navigation


Sticky-DO 📝

Sticky-DO is a full-stack web application that brings the simplicity of sticky notes to the digital world, combined with powerful to-do list functionalities. It's designed to help you organize your thoughts, tasks, and reminders in a visually intuitive way. Demo: https://eclectic-rabanadas-b8dd11.netlify.app/ Backend API: https://sticky-do.onrender.com


Challenges

I have faced many challenges in developing this application. I have listed some of them here with the solution I came up with.


Sources

This section lists some of the sources that I have used as reference. This also includes the sources that I have used for debugging.


Features

  • 📝 Create & Manage Notes: Easily create, edit, and delete notes.
  • 🎨 Color Coding: Organize your notes by color for better categorization.
  • 🖐️ Drag & Drop: Intuitively arrange your notes on the board.

Tech Stack

The project is built with a modern MERN-like stack.

  • Client-Side (Frontend)

    • React: A JavaScript library for building user interfaces.
    • Axios: For making HTTP requests to the server.
    • CSS3: For styling the application.
  • Server-Side (Backend)

    • Node.js: A JavaScript runtime environment.
    • Express.js: A minimal and flexible Node.js web application framework.
    • MongoDB: A NoSQL database to store user and note data.
    • Mongoose: An ODM library for MongoDB and Node.js.

Project Structure

The project is organized into two main folders:

Sticky-DO/
├── client/         # Contains the React frontend application
|    ├── src/
|    └── index.html
|    
└── server/         # Contains the Node.js/Express backend API
    ├── models/
    ├── DBConnection.js
    └── index.js

Getting Started

To get a local copy up and running, follow these simple steps.

Prerequisites

Make sure you have Node.js and npm installed on your machine.

You will also need a MongoDB database. You can use a local installation or a cloud service like MongoDB Atlas.

Installation & Setup

  1. Clone the repository:

    git clone https://github.com/your-username/Sticky-DO.git
    cd Sticky-DO
  2. Set up the Backend Server:

    • Navigate to the server directory:
      cd server
    • Install the required npm packages:
      npm install
    • Create a .env file in the server directory. This file will store your environment variables.
      MONGO_URI=your_mongodb_connection_string
    • Start the server:
      npm run start

    The server should now be running on http://localhost:3000.

  3. Set up the Frontend Client:

    • Open a new terminal and navigate to the client directory from the project's root:
      cd client
    • Install the required npm packages:
      npm install
    • Start the React development server:
      npm run start

    The client application should now be running on http://localhost:5173 and connected to the backend.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published