Welcome to the vibrant world of Spruce, a robust open-source social networking platform crafted using Node.js and MongoDB! This guide will navigate you through the steps needed to install and run Spruce on your local machine. So, roll up your sleeves as we dive in!

Features of Spruce

• Sign in with local authentication, Instagram, or Google.
• Real-time chat functionality with friends.
• Categorized feeds: thoughts (tweets), events (location specified), and moments (personal posts).
• Like and comment on posts.
• API access for developers.
• Follow users and get activity notifications.
• Profile customization options.
• Electron app coming soon!

Requirements

Before we get started, ensure that you have the following installed:

• Node.js
• Express.js – a middleware framework for Node.js.
• EJS – Embedded JavaScript templates.
• MongoDB – our database of choice!

Installation Steps

bash
$ git clone https://github.com/dan-divy/spruce.git
$ cd spruce
$ npm install

Configuration for Local Development

Before diving into development, you need to set up the API credentials for Instagram and Google:

1. Locate the config directory in the repo.
2. Open instagram.js and google.js, where you will insert your CLIENT_ID and CLIENT_SECRET.
3. Replace the placeholder values with your actual API credentials, ensuring to set the redirect URI as specified by the respective API dashboards.

Here’s a snippet to guide you:

javascript
// REPLACE YOUR API CREDENTIALS HERE
var in_client_id = XXXXXXXXXXXXXXXXXX; // CLIENT_ID
var in_client_secret = XXXXXXXXXXXXXXXXXXXX; // CLIENT_SECRET
var in_redirect_uri = http://localhost:80/account/oauth; // Modified as per your setup

Starting the Application

With your credentials set, you’re on the home stretch. Follow these commands to launch your MongoDB server and then start the Spruce server:

bash
$ mongod
$ npm start

Understanding the Code

Spruce’s architecture is like a neatly arranged library. Imagine the books (data) stored on shelves (MongoDB), and the librarian (Express.js) who helps you find, check out, and manage these books efficiently. Mongoose, serving as an ORM, is like a cataloging system that allows you to interact with your library in a more pleasing and structured manner.

Troubleshooting Tips

• Error during installation: Ensure that you have installed Node.js and NPM correctly. You can verify installations by running node -v and npm -v.
• MongoDB not starting: Try running mongod in a separate terminal window. Ensure that MongoDB is correctly installed and running.
• API Credentials Issues: Double-check that your client ID and client secret are correct and that they match the settings in your respective Instagram and Google API dashboards.

For more insights, updates, or to collaborate on AI development projects, stay connected with fxis.ai.

Conclusion

Congratulations! You are now well-equipped to set up and run your own instance of Spruce. Dive into building your social networking experience, and don’t forget that contributions are always welcome!

At fxis.ai, we believe that such advancements are crucial for the future of AI, as they enable more comprehensive and effective solutions. Our team is continually exploring new methodologies to push the envelope in artificial intelligence, ensuring that our clients benefit from the latest technological innovations.