|
| 1 | + |
| 2 | +# NoteNest | Personal Notes & Task Management App |
| 3 | + |
| 4 | +**NoteNest** is a feature-rich personal notes and task management application designed to help you stay organized and productive. Built with a robust client-server architecture, NoteNest allows users to: |
| 5 | +- Create, edit, and manage **notes**. |
| 6 | +- Organize and track **tasks** effectively. |
| 7 | +- Provide and receive **feedback** for collaborative improvements. |
| 8 | +- Enjoy a sleek and responsive UI powered by **ShadCN components**. |
| 9 | + |
| 10 | +--- |
| 11 | + |
| 12 | +## Features |
| 13 | + |
| 14 | +1. **Notes Management**: |
| 15 | + Effortlessly create, edit, delete, and search through your notes. |
| 16 | + |
| 17 | +2. **Task Tracking**: |
| 18 | + Organize your tasks with status updates, due dates, and priority management. |
| 19 | + |
| 20 | +3. **Feedback System**: |
| 21 | + Submit feedback to enhance your experience or report issues. |
| 22 | + |
| 23 | +4. **Modern UI**: |
| 24 | + Built with **ShadCN components**, ensuring a clean, accessible, and responsive design. |
| 25 | + |
| 26 | +5. **Secure Backend**: |
| 27 | + Utilizes salted hashing with **PEPPER** and secure JWT tokens for user authentication. |
| 28 | + |
| 29 | +--- |
| 30 | + |
| 31 | +## Prerequisites |
| 32 | + |
| 33 | +Before running the app, ensure you have the following installed: |
| 34 | + |
| 35 | +- **Node.js** |
| 36 | +- **npm** (Node Package Manager) |
| 37 | +- **MongoDB** |
| 38 | + |
| 39 | +--- |
| 40 | + |
| 41 | +## Installation |
| 42 | + |
| 43 | +To set up NoteNest, clone this repository and install dependencies for both the **client** and **server**. |
| 44 | + |
| 45 | +### Client Setup |
| 46 | + |
| 47 | +1. Navigate to the `client` directory: |
| 48 | + |
| 49 | + ```bash |
| 50 | + cd client |
| 51 | + ``` |
| 52 | + |
| 53 | +2. Install dependencies: |
| 54 | + |
| 55 | + ```bash |
| 56 | + npm install |
| 57 | + ``` |
| 58 | + |
| 59 | +3. Create a `.env` file in the `client` directory with the following content: |
| 60 | + |
| 61 | + ```env |
| 62 | + VITE_SERVER=<YOUR_SERVER_URL> |
| 63 | + ``` |
| 64 | + |
| 65 | +4. Run the client application: |
| 66 | + |
| 67 | + ```bash |
| 68 | + npm run dev |
| 69 | + ``` |
| 70 | + |
| 71 | + The client app will run on `http://localhost:5173`. |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +### Server Setup |
| 76 | + |
| 77 | +1. Navigate to the `server` directory: |
| 78 | + |
| 79 | + ```bash |
| 80 | + cd server |
| 81 | + ``` |
| 82 | + |
| 83 | +2. Install dependencies: |
| 84 | + |
| 85 | + ```bash |
| 86 | + npm install |
| 87 | + ``` |
| 88 | + |
| 89 | +3. Create a `.env` file in the `server` directory with the following content: |
| 90 | + |
| 91 | + ```env |
| 92 | + DATABASE_URI=<YOUR_MONGODB_URI> |
| 93 | + PORT=<YOUR_SERVER_PORT> |
| 94 | + CLIENT_URL=<YOUR_CLIENT_URL> |
| 95 | + PEPPER=<YOUR_PEPPER_VALUE> |
| 96 | + JWT_SECRET=<YOUR_JWT_SECRET> |
| 97 | + ``` |
| 98 | + |
| 99 | +4. Run the server application: |
| 100 | + |
| 101 | + ```bash |
| 102 | + npm run dev |
| 103 | + ``` |
| 104 | + |
| 105 | + The server app will run on `http://localhost:5000`. |
| 106 | + |
| 107 | +--- |
| 108 | + |
| 109 | +## Accessing the App |
| 110 | + |
| 111 | +Once the client and server are running, you can access NoteNest by navigating to: |
| 112 | + |
| 113 | +[http://localhost:5173](http://localhost:5173) |
| 114 | + |
| 115 | +--- |
| 116 | + |
| 117 | +## Key Technologies Used |
| 118 | + |
| 119 | +- **Frontend**: React with **ShadCN UI components**. |
| 120 | +- **Backend**: Node.js, Express.js. |
| 121 | +- **Database**: MongoDB. |
| 122 | +- **Authentication**: JWT with salted password hashing using **PEPPER**. |
| 123 | +- **Environment Management**: `.env` for secure configurations. |
| 124 | + |
| 125 | +--- |
| 126 | + |
| 127 | +## Contributing |
| 128 | + |
| 129 | +We welcome contributions! To contribute: |
| 130 | +1. Fork the repository. |
| 131 | +2. Create a new branch for your feature/bugfix. |
| 132 | +3. Commit your changes and submit a pull request. |
| 133 | + |
| 134 | +--- |
| 135 | + |
| 136 | +## Feedback & Support |
| 137 | + |
| 138 | +Encounter issues or have suggestions? Submit your feedback through the app or raise an issue on the GitHub repository. |
| 139 | + |
| 140 | +--- |
0 commit comments