Skip to content

Abhay-hack/Digilekh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e9b6e34 Β· Dec 20, 2024

History

25 Commits
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024
Dec 20, 2024

Repository files navigation

#✨ Digilekh

Digilekh is a web application designed to manage .

πŸ” Project Overview

πŸš€ Features


🚧 Getting Started

To set up this project locally, follow these instructions:

1. Backend

To set up the backend, you need to install the following dependencies:

  • Languages and Frameworks:

    • Node.js (runtime environment)
    • Express.js (web framework)
  • Database:

    • MongoDB (or your chosen database)
  • Others:

    • Any backend-specific packages listed in package.json.

Steps to Install Backend Dependencies:

  1. Navigate to the backend directory:

    cd backend
  2. Install Dependencies

    npm i
    npm install express
    npm install jsonwebtoken
    npm install multer mongoose socket.io dotenv cors body-parser cookie-parser
  3. If not already installed, consider adding these development utilities: ``sh npm install nodemon --save-dev

  4. Create a .env file

    PORT=your-port-number
    MONGO_URI=your-mongo-uri
    JWT_SECRET=your-jwt-secret
    NODE_ENV=production
    

πŸ—‚οΈ Backend Folder Structure:

project/
β”œβ”€β”€ middleware/
β”‚   β”œβ”€β”€ multer.js         // Custom multer configuration
β”‚   └── auth.js           // Authentication middleware
β”œβ”€β”€ models/
β”‚   β”œβ”€β”€ blog.js
β”‚   β”œβ”€β”€ comment.js
β”‚   β”œβ”€β”€ community.js
β”‚   └── user.js
β”œβ”€β”€ socket.js              // Socket implementation
β”œβ”€β”€ routes/
β”‚   β”œβ”€β”€ blogRouter.js
β”‚   β”œβ”€β”€ communityRouter.js
β”‚   └── userRouter.js
β”œβ”€β”€ uploads/               // Directory for uploaded files
β”œβ”€β”€ index.js
β”œβ”€β”€ .env                   // Environment variables
└── package.json

How to run

node index.js

or

nodemon index.js

2. Frontend

To set up the backend, you need to install the following dependencies:

  • Languages and Frameworks:
  • React.js

Steps to Install Backend Dependencies:

  1. Navigate to the frontend directory:
    cd frontend
  2. Install Dependencies
    npm i
    npm install react-router-dom axios socket.io-client styled-components moment
    npm i react-icons emoji-picker-react
    

How to run

npm run dev

πŸ—‚οΈ Frontend Folder Structure

src/
β”œβ”€β”€ components/
β”‚   β”œβ”€β”€ Header.js
β”‚   β”œβ”€β”€ Loader.js
β”‚   β”œβ”€β”€ CommentSection.js
β”‚   └── BlogPost.js
β”œβ”€β”€ pages/
β”‚   β”œβ”€β”€ Home.js
β”‚   β”œβ”€β”€ About.js
β”‚   β”œβ”€β”€ Contact.js
β”‚   β”œβ”€β”€ Signup.js
β”‚   β”œβ”€β”€ Login.js
β”‚   β”œβ”€β”€ Profile.js
β”‚   β”œβ”€β”€ Blogs.js
β”‚   β”œβ”€β”€ BlogDetail.js
β”‚   β”œβ”€β”€ CommunityList.js
β”‚   β”œβ”€β”€ CommunityDetail.js
β”‚   └── CommunityCreate.js
β”œβ”€β”€ assets/
β”‚   └── user.png
β”œβ”€β”€ axios/
β”‚   β”œβ”€β”€ index.js           # Configure axios instances here
β”œβ”€β”€ App.js
└── index.js

🎯 How to Use

πŸ‘€ Author

This project was created by Abhay Gupta. Feel free to connect on LinkedIn or check out more projects on GitHub.

Releases

No releases published

Packages

No packages published

Languages