InsightSync is a platform designed to bring ideas to life through meaningful discussions. It connects curious minds, allowing users to share perspectives, explore diverse topics, and gain valuable insights. Whether you want to contribute your thoughts or learn from others, InsightSync makes knowledge-sharing effortless and engaging.
InsightSync has been a part of various open-source programs, providing contributors a platform to collaborate, learn, and build impactful solutions together.
We welcome contributions! If you're interested in contributing, please check out the Contributors.md
file for guidelines on how to get started.
Happy coding! 💻✨
- Curated Content: Access a wide range of articles and resources on diverse topics.
- User-Friendly Interface: Easy navigation and an engaging design enhance the user experience.
- Community Discussions: Connect with other users, share insights, and participate in discussions.
- Free Access: All features and content are available for free, promoting inclusive learning.
-
Clone the Repository:
Clone the project to your local machine using the following command:git clone https://github.com/yourusername/insightsync.git
-
Navigate to the Project Directory:
cd insightsync
-
Create a New Branch: Create a new branch for your feature or bug fix. Use a descriptive name:
git checkout -b feature/YourFeatureName
-
Perform Your Tasks: Make the necessary changes and implement your feature or fix.
-
Commit Your Changes: Add and commit your changes with a meaningful message:
git add . git commit -m "Add a brief description of your changes"
-
Push Your Changes: Push your branch to the remote repository:
git push origin feature/YourFeatureName
-
Create a Pull Request: Once your changes are pushed, submit a pull request for review.
- Create a
.env
File
To store your environment variables securely, navigate to the server
folder and create a .env
file. This file will store your MongoDB connection string.
MONGO_URI="your_mongodb_connection_url"
Make sure to replace your_mongodb_connection_url
with your actual MongoDB URL. Keep this file private and do not share it publicly.
- Navigate to the
server
Folder
Before running the server, ensure that you are inside the server
directory. You can check your current directory using:
pwd # For macOS/Linux
cd # For Windows (shows current directory)
If you are not in the server
folder, navigate to it using:
cd server
- Start the Server
Once inside the server
folder, you can start the server using nodemon
. Run the following command:
nodemon api/index.js
This will start your backend server, ensuring that any code changes will automatically restart the server.
If nodemon
is not installed, you can install it globally using:
npm install -g nodemon
Now if you want to deploy the backend check Deployment.md