https://github.com/soorajvp/bytepad
Web Application for storing the Notes in cloud side
https://github.com/soorajvp/bytepad
express-js jsonwebtoken nodejs postgresql quill-editor reactjs redux-toolkit sequelize-orm tailwindcss
Last synced: 2 months ago
JSON representation
Web Application for storing the Notes in cloud side
- Host: GitHub
- URL: https://github.com/soorajvp/bytepad
- Owner: SoorajVp
- Created: 2023-11-03T18:15:28.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T10:29:58.000Z (over 1 year ago)
- Last Synced: 2026-01-03T14:28:17.285Z (5 months ago)
- Topics: express-js, jsonwebtoken, nodejs, postgresql, quill-editor, reactjs, redux-toolkit, sequelize-orm, tailwindcss
- Language: JavaScript
- Homepage:
- Size: 5.06 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BYTEPAD - Note Storage Web Application
BYTEPAD is a robust note storage web application designed for users to seamlessly access their texted notes from any location and device. The application was crafted using a combination of cutting-edge technologies, demonstrating a commitment to modern development practices:
## Technologies Used
- Node.js and Express.js for the backend
- PostgreSQL database with Sequelize ORM, following the MVC architecture
- React.js for the frontend
- Tailwind CSS for styling
- Redux Toolkit for state management
- Axios for handling API requests
- Formik and Yup for form validations
- JWT for authentication
- Twilio service for mobile OTP verification
- Designed and implemented an array of features for an optimal user experience
## Features
- Registration with username, mobile number, and password
- Login with secure JWT-based authentication
- Forgot password with mobile OTP verification and reset password.
- Note creation, editing, and deletion
- User details update (username, mobile number)
- Password change with verification of the old password
- The backend and frontend technologies work seamlessly together, ensuring a smooth user experience and efficient data management.
## Get Started
1. Clone this repository.
```bash
git clone https://github.com/SoorajVp/BytePad.git
cd client/
cd server/
```
2. Install dependencies using `npm install` ( client and server side ).
3. Configure environment variables on server side(e.g., database connection, port, jwt secret-key, twilio credentials).
```plaintext
SERVER_PORT = 4000
TOKEN_SECRET_KEY = ""
DB_NAME = ""
DB_USERNAME = ""
DB_PASSWORD = ""
TWILIO_ACCOUNT_SID =
TWILIO_AUTH_TOKEN =
TWILIO_VERIFY_SID =
```
4. Run the application using `npm run dev`.