Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jabedalimollah/notebook
This is my notebook project and I am creating it using MERN stack
https://github.com/jabedalimollah/notebook
axios cors css3 expressjs javascript jsonwebtoken mongodb-database mongoose node nodejs react-icons react-router react-router-dom reactjs shadcn-ui tailwindcss zod-validation
Last synced: 9 days ago
JSON representation
This is my notebook project and I am creating it using MERN stack
- Host: GitHub
- URL: https://github.com/jabedalimollah/notebook
- Owner: jabedalimollah
- Created: 2024-07-01T10:30:12.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-24T18:14:32.000Z (about 1 month ago)
- Last Synced: 2024-09-18T02:56:45.885Z (17 days ago)
- Topics: axios, cors, css3, expressjs, javascript, jsonwebtoken, mongodb-database, mongoose, node, nodejs, react-icons, react-router, react-router-dom, reactjs, shadcn-ui, tailwindcss, zod-validation
- Language: JavaScript
- Homepage: https://notebook7.netlify.app
- Size: 9.22 MB
- Stars: 11
- Watchers: 1
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📓 Notebook - Secure Note-Taking Platform
Notebook is a secure, full-featured note-taking platform built with the MERN stack. It offers robust features for managing, securing, and organizing your notes, making it an ideal tool for both personal and professional use.
## 🔗 Live Demo
Check out the live demo of the Notebook project [here](https://notebook7.netlify.app/).
## 🚀 Features
- Secure User Authentication: Register and login with secure authentication to protect your notes.
- Note Management: Easily create, update, and delete notes.
- Export Options: Export your notes as PDF or TXT files for sharing or backup.
- Clipboard Copy: Copy notes directly to your clipboard with a single click.
- File Import: Import notes seamlessly from TXT files.
- Advanced Search & Sorting: Quickly find and organize notes with powerful search and sorting tools.
- Checklist Functionality: Create and manage tasks within your notes using checklists.
## 🛠️ Technologies Used
**Client:** React, Redux, TailwindCSS, Axios
**Server:** Node, Express
**Database:** MongoDB
## 🖥️ Installation
### Prerequisites
- Node.js and npm installed on your machine.
- MongoDB installed and running locally or have access to a MongoDB Atlas cluster.
### Clone the Repository
```bash
git clone https://github.com/jabedalimollah/notebook.git
cd notebook
```
### Backend Setup
- Navigate to the backend directory:
```bash
cd backend
```
- Install the required dependencies:
```bash
npm install
```
- Create a .env file in the backend directory and add your environment variables:
```bash
MONGO_URI=
JWT_SECRET=
PORT=5000
DB_NAME=
CORS_ORIGIN=
```
- Start the backend server
```bash
npm run dev
```
### Frontend Setup
- Navigate to the frontend directory:
```bash
cd frontend
```
- Install the required dependencies:
```bash
npm install
```
- Create a .env file in the frontend directory and add your environment variables:
```bash
VITE_APP_CONTACT_URL=
VITE_APP_API_KEY=http://localhost:5000/api
```
- Start the frontend development server:
```bash
npm run dev
```
### Running the Application
- Ensure both the frontend and backend servers are running.
- Open your browser and navigate to http://localhost:5173.
## Environment Variables
To run this project, you will need to add the following environment variables to your .env file
### Frontend
`VITE_APP_CONTACT_URL`
`VITE_APP_API_KEY`
### Backend
`PORT`
`MONGODB_URI`
`DB_NAME`
`JWT_SECRET_KEY`
`CORS_ORIGIN`
## Screenshots
## 📧 Contact
- Email: [email protected]
- LinkedIn: [Jabed Ali Mollah](https://www.linkedin.com/in/jabedalimollah)
- GitHub: [Jabed Ali Mollah](https://github.com/jabedalimollah)
#
If you find this project useful, don't forget to star the repository! ⭐
#
## 🔗 Links
[](https://jabedalimollah.netlify.app/)
[](https://www.linkedin.com/in/jabedalimollah/)
[](https://x.com/JabedAliMollah7)