Skip to content

README.md

Latest commit

 

History

History
41 lines (32 loc) · 1.76 KB

README.md

File metadata and controls

41 lines (32 loc) · 1.76 KB

ShareIT

ShareIt is a MERN (MongoDB, Express.js, React, Node.js) stack application that allows users to create and share content with a title. Users have the option to make their content public for everyone to view or keep it private.

You can view the app demo @Youtube.

Features

  • User Authentication: Users can sign up, log in, and manage their accounts.
  • Create Content: Users can create content by providing a title and the actual content.
  • Privacy Settings: Choose between making the content public or private.
  • View Content: Public content is accessible to all users.

Tech Stack

  • Frontend: React, Tailwind, MaterialTailwind
  • Backend: Node.js, Express.js, JWT
  • Database: MongoDB

Getting Started

  • To run this app locally, follow these steps:

  • Clone the repository to your local machine: git clone https://github.com/Krishrx/shareIT.git

  • Navigate to the project directory: cd shareIT

  • Install the project dependencies: npm install

  • Similarly cd into backend and frontend and do: npm install

  • Create .env file in backend and write: PORT=8000 MONGODB_URI=your_mongodb_connection_string SECRET=create_secret_string

  • Start the development server: npm run dev

Contributions

I welcome contributions and suggestions from the community. If you have ideas to improve the app, feel free to reach out to me or submit pull requests on the GitHub repository.

Feedback

I value your feedback! If you have any suggestions or bug reports, please open an issue on this repository. If you want to share your experience, please don't hesitate to contact me. You can reach me directly through the contact information provided on GitHub.