This project is an online rich text editor built with React (Vite), NodeJS and MariaDB.
- Rich text editing capabilities
- User authentication and authorization
- Role-based access control
- Persistent login sessions
- Node.js (v14 or higher)
- npm or yarn
- MariaDB on Port 3306
-
Clone the repository:
git clone https://github.com/Sujas-Aggarwal/clean-docs.git cd clean-docs
-
Install dependencies for both client and server:
cd client npm install cd ../server npm install
Configure the .env files in both client and server based on the .env.example
Make Sure that MariaDB or MySQL is runnin on your device on PORT 3306 (default port)
Now to Migrate, Simply run server/database/migrations/init.js
-
Start the server:
cd server node
-
Start the client:
cd client npm start
-
Open your browser and navigate to
http://localhost:3000
.
client/
: Contains the React frontend code.server/
: Contains the Express backend code.