Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dan-divy/spruce
A social networking platform made using Node.js and MongoDB
https://github.com/dan-divy/spruce
api css electron express html javascript mean mean-stack media mongo mongodb mongodb-database mongoose node nodejs oauth oauth2 social social-login social-network
Last synced: 2 months ago
JSON representation
A social networking platform made using Node.js and MongoDB
- Host: GitHub
- URL: https://github.com/dan-divy/spruce
- Owner: dan-divy
- License: mit
- Created: 2019-01-16T12:46:40.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T20:44:41.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T03:32:05.706Z (8 months ago)
- Topics: api, css, electron, express, html, javascript, mean, mean-stack, media, mongo, mongodb, mongodb-database, mongoose, node, nodejs, oauth, oauth2, social, social-login, social-network
- Language: SCSS
- Homepage:
- Size: 107 MB
- Stars: 494
- Watchers: 26
- Forks: 117
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Welcome to Spruce
Spruce is a tiny but powerful open-source social networking platform made with Node.js and MongoDB.
[](https://opencollective.com/dan_divy) [](https://gitter.im/spruce-social/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [](https://www.codacy.com/app/DivySrivastava/spruce?utm_source=github.com&utm_medium=referral&utm_content=DivySrivastava/spruce&utm_campaign=Badge_Grade)   [](https://discord.gg/DPRZuB4)
_Deployed_ [_here_](https://sprucev3.dancodes.online/)
Get the live MongoDB stats out [here](https://cloud.mongodb.com/freemonitoring/cluster/SQXXT6OAMR757LIEYJRN3WDUCIRAEYYV).
## 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
- [Node.js](https://nodejs.org)
- expressjs [ExpressJS HTTP middleware](https://npmjs.org/package/express)
- ejs [Embedded JavaScript templates](https://npmjs.org/package/ejs)
- [MongoDB](http://mongodb.org)
## Installation
Clone the repo locally then install all the dependencies using [NPM](https://npmjs.org/)
```bash
$ 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 ``, `` and `:` with our own API credentials
```javascript
/** REPLACE YOUR API CREDENTIALS HERE **/
var in_client_id = 'XXXXXXXXXXXXXXXXXX', //
in_client_secret = 'XXXXXXXXXXXXXXXXXXXX', //
```
Now Replace the `` & `` with the redirect uri specified in the [Instagram API Dashboard](https://www.instagram.com/developer) and [Google API Dashboard](https://developers.google.com). Default is `http://localhost:80/account/oauth`.
```javascript
var in_redirect_uri = "http://localhost:80/account/oauth/:service";
```
Finally start the MongoDB server in a seperate bash/pm2
```bash
$ mongod
```
and then start the spruce server via `npm`.
```bash
$ npm start
```
## To know
spruce uses [mongoose](https://npmjs.org/package/mongoose) as an ORM for performing CRUD operations on MongoDB and [express.js](https://npmjs.com/package/express) for server-side HTTP routing.
**This project needs contributors!!**
## Authors
- [Divy Srivastava](http://github.com/DivySrivastava)
- [Dan](https://github.com/dan-online)
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/dan_divy/contribute)]
#### Individuals
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/dan_divy/contribute)]
## License
\(The MIT License\)
Copyright \(c\) 2019 Divy Srivastava [[email protected]](mailto:[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.