Skip to content

Latest commit

 

History

History
136 lines (88 loc) · 6.85 KB

README.md

File metadata and controls

136 lines (88 loc) · 6.85 KB
Raw

Welcome to Spruce

Spruce is a tiny but powerful open-source social networking platform made with Node.js and MongoDB.

Financial Contributors on Open Collective Gitter Codacy Badge Discord

Deployed here

Get the live MongoDB stats out here.

Features

  • Sign in using local authentication, Instagram or Google.
  • Search for your other users.
  • Chat with your friends in realtime.
  • All feeds divided into 3 categories
    • thoughts (tweets)
    • events (location can be specified)
    • moments (personal post)
  • Like and comment on a feed.
  • API for developers
  • View your/others profile.
  • Follow a particular user and get notified for his/her activities.
  • Change your profile picture, bio, people who follow you etc.
  • Electron app

And a lot more to be added soon...

To Do's

  • Activity feature for user to see follow requests and his/her daily activity.
  • Notifications

Requirements

Installation

Clone the repo locally then install all the dependencies using NPM

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

Local Development

Before running, we need to add the Instgram and Google API Credentials to the project. Under the config directory of the repo, you will find instagram.js and google.js. We need to add the <CLIENT_ID>, <CLIENT_SECRET> and <host>:<port> with our own API credentials

/** REPLACE YOUR API CREDENTIALS HERE **/
var in_client_id = 'XXXXXXXXXXXXXXXXXX', // <CLIENT_ID>
    in_client_secret = 'XXXXXXXXXXXXXXXXXXXX', // <CLIENT_SECRET>

Now Replace the <host> & <port> with the redirect uri specified in the Instagram API Dashboard and Google API Dashboard. Default is http://localhost:80/account/oauth.

var in_redirect_uri = "http://localhost:80/account/oauth/:service";

Finally start the MongoDB server in a seperate bash/pm2

$ mongod

and then start the spruce server via npm.

$ npm start

To know

spruce uses mongoose as an ORM for performing CRUD operations on MongoDB and express.js for server-side HTTP routing.

This project needs contributors!!

Authors

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]

License

(The MIT License)

Copyright (c) 2019 Divy Srivastava [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.