Skip to content

devi5040/Infostore-Project

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

52 Commits
 
 
 
 
 
 
 
 

Repository files navigation

InfoStore: Your Personal Information Hub

A personal hub to organize and access your information easily.

GitHub top language GitHub last commit

2. Table of Contents


3. Project Overview/Purpose

InfoStore is a personal information management system designed to help users securely store and organize their important data. It allows users to keep track of documents, educational qualifications, and passwords in a centralized and easily accessible location. This project aims to simplify the management of personal information and enhance security for individual users.


4. Features/Functionality

  • Secure storage of personal documents.
  • Centralized management of educational qualifications.
  • Secure password storage and management.
  • User authentication and authorization.
  • User profile management.

5. Tech Stack

Frontend:

  • React
  • Redux
  • React Router DOM
  • Tailwind CSS
  • Axios

Backend:

  • Node.js
  • Express.js
  • MongoDB
  • Mongoose
  • bcryptjs
  • jsonwebtoken
  • AWS SDK (for S3)
  • nodemailer
  • express-validator
  • cookie-parser
  • cors

6. Installation/Setup Instructions

These instructions assume you have Node.js and npm (or yarn) installed.

Backend:

  1. Clone the repository:
    git clone <repository url>
  2. Navigate to the backend directory:
    cd backend
  3. Install dependencies:
    npm install
  4. Configure environment variables (see below).
  5. Start the server:
    npm start

Frontend:

  1. Navigate to the frontend directory:
    cd infostore-frontend
  2. Install dependencies:
    npm install
  3. Start the development server:
    npm run dev

7. Config/Environment Variables

You need to create a .env file in both the backend and infostore-frontend directories with the following variables:

Backend .env:

  • MONGODB_URI: Your MongoDB connection string.
  • JWT_SECRET: A secret key for JSON Web Tokens.
  • AWS_ACCESS_KEY_ID: Your AWS access key ID.
  • AWS_SECRET_ACCESS_KEY: Your AWS secret access key.
  • AWS_REGION: Your AWS region.
  • AWS_BUCKET_NAME: Name of your S3 bucket.
  • EMAIL_USER: Your email address for sending OTP.
  • EMAIL_PASS: Your email password for sending OTP.

Frontend .env:

  • REACT_APP_BACKEND_URL: The base URL of your backend API.

10. Coding standards/Linting

The frontend utilizes ESLint for code linting. Run npm run lint in the infostore-frontend directory to check for code style issues.


11. License

MIT License


12. Author details

Deviprasad Rai P dpraidola@gmail.com

About

A full-stack MERN application for securely storing and managing personal documents and data across devices. Features include Passport.js authentication, a user-friendly UI for organizing and retrieving information, and scalable backend APIs built with Node.js, Express, and MongoDB.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages