Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/victoriamcn/nosql-social-network
An API for a social network web application where users can share thoughts, react and create a friend list. Express.js is used for routing. MongoDB is used for the database along with Mongoose ODM
https://github.com/victoriamcn/nosql-social-network
dotenv expressjs javascript mongodb mongoose nodejs
Last synced: 2 days ago
JSON representation
An API for a social network web application where users can share thoughts, react and create a friend list. Express.js is used for routing. MongoDB is used for the database along with Mongoose ODM
- Host: GitHub
- URL: https://github.com/victoriamcn/nosql-social-network
- Owner: victoriamcn
- License: mit
- Created: 2023-05-22T22:04:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-06-20T17:33:16.000Z (over 1 year ago)
- Last Synced: 2024-11-16T19:25:45.367Z (2 months ago)
- Topics: dotenv, expressjs, javascript, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage: https://www.youtube.com/watch?v=CzLSilbr5A0
- Size: 63.5 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Thought: NoSQL Social Network
## Description
An API for a social network web application where users can share thoughts, react and create a friend list. Express.js is used for routing. MongoDB is used for the database along with Mongoose ODM
## Table of Contents
- [NoSQL Social Network](#NoSQL-Social-Network)
- [Description](#description)
- [Table of Contents](#table-of-contents)
- [User Story](#user-story)
- [Installation and Usage](#installation-and-usage)
- [Demo](#demo)
- [Contributing](#contributing)
- [License](#license)
- [Credits](#credits)
- [Georgia Tech Staff](#Georgia-Tech-Staff)
- [Example Code](#example-code)
- [Tutorials](#tutorials)
- [Node Dependencies](#node-dependencies)
- [Badges](#badges)
## User Story
```
AS A social media startup
I WANT an API for my social network that uses a NoSQL database
SO THAT my website can handle large amounts of unstructured data
```
## Installation and Usage
1. Clone this repository to your local computer.
2. Open the repo in VS Code.
3. Open the index.js file in the Integrated Terminal.
4. Type the following in the command line: ```npm i```
5. Create your own ```.env``` file with the following content:
```
MONGODB_URI = '(mongodbconnection)/mydatabase'
```
6. Replace the content between the single quotation marks ```' '``` in your MongoDB URL connection in the ```.env``` file.
7. Type the following in the command line: ```node index.js```
8. Use Insomnia to test the application functionality. Below are all routes to test:
- ```/api/users```
- ```GET``` all users
- ```GET``` a single user by its ```_id```
- ```POST``` a new user (See example data for new user)
- ```PUT``` to update a user by its ```_id```
- ```DELETE``` to remove a user by its ```_id```
```
// example data for new user
{
"username": "lernantino",
"email": "[email protected]"
}
```
- ```/api/users/:userId/friends/:friendId```
- ```POST``` to add a new friend to a user's friend list
- ```DELETE``` to remove a friend from a user's friend list
- ```/api/thoughts```
- ```GET``` to get all thoughts
- ```GET``` to get a single thought by its ```_id```
- ```POST``` to create a new thought (See example data for new thought)
- ```PUT``` to update a thought by its ```_id```
- ```DELETE``` to remove a thought by its ```_id```
```
// example data for new thought
{
"thoughtText": "Here's a cool thought...",
"username": "lernantino",
"userId": "5edff358a0fcb779aa7b118b"
}
```
- ```/api/thoughts/:thoughtId/reactions```
- ```POST``` to create a reaction stored in a single thought's ```reactions``` array field
- ```DELETE``` to pull and remove a reaction by the reaction's ```reactionId``` value
## Demo
Please see the demo on [YouTube](https://youtu.be/CzLSilbr5A0).
## Contributing
## License
[MIT](https://img.shields.io/badge/License-MIT-blue.svg)
This project is licensed under MIT.
## Credits
### Georgia Tech Staff
My instructor, [Saurav Khatiwada](https://github.com/khatiwadasaurav).
### Example Code
- GitHub: [njthanhtrang](https://github.com/njthanhtrang/18.-NoSQL-Challenge-Social-Network-API/blob/main/controllers/user-controller.js)
### Tutorials
- freeCodeCamp: [Introduction to Mongoose for MongoDB](https://www.freecodecamp.org/news/introduction-to-mongoose-for-mongodb-d2a7aa593c57/)
- Mastering JS: [How to Validate Unique Emails with Mongoose](https://masteringjs.io/tutorials/mongoose/mongoose-validate-unique-email)
- MongoDB: [CRUD Operations](https://www.mongodb.com/docs/manual/crud/)
- Mozilla: [Express Tutorial Part 4: Routes and controllers](https://developer.mozilla.org/en-US/docs/Learn/Server-side/Express_Nodejs/routes)
- StackOverflow: [How To Create Mongoose Schema with Array of Object IDs?](https://stackoverflow.com/questions/22244421/how-to-create-mongoose-schema-with-array-of-object-ids)
- StackOverflow: [how to use getter or setter with mongoose timestamps?](https://stackoverflow.com/questions/70724966/how-to-use-getter-or-setter-with-mongoose-timestamps)
- StackOverflow: [Removing white spaces (leading and trailing) from string value](https://stackoverflow.com/questions/23903785/removing-white-spaces-leading-and-trailing-from-string-value)
- StackOverflow: [Route.get() requires callback functions but got a "object Undefined"](https://stackoverflow.com/questions/36558909/route-get-requires-callback-functions-but-got-a-object-undefined)
### Node Dependencies
Click links to read the documentation for each dependency:
- [dotenv](https://www.npmjs.com/package/dotenv)
- [express](https://www.npmjs.com/package/express)
- [mongoose](https://www.npmjs.com/package/mongoose)
### Badges
[](https://github.com/)
