SocioLink API

Table of Contents

• Description
• Features
• Technologies
• Installation
• Usage Information
• Screenshots
• Links
• License
• Questions

Description

SocioLink is a RESTful API for a social networking application where users can share thoughts, react to other users' thoughts, and manage a friend list. This API allows CRUD operations for users, thoughts, reactions, and friendships.

Features

1. User Management: Create, read, update, and delete users.
2. Thought Management: Create, read, update, and delete thoughts.
3. Reaction Management: Add and remove reactions to thoughts.
4. Friendship Management: Add and remove friends.

Technologies

1. Node.js: Runtime environment for building the backend.
2. Express.js: Web framework for building REST APIs.
3. MongoDB: NoSQL database for storing users, thoughts, and reactions.
4. Mongoose: ODM for MongoDB, providing a schema-based solution.
5. TypeScript: For type safety and better code maintainability.

Installation

1. Clone repo
2. npm i
3. Create a .env file in the root directory and configure the following environment variables: MONGO_URI=
4. npm run build
5. npm run seed
6. npm run start

Usage Information

1. Use tools like Postman or Insomnia to interact with the API endpoints. 2. Use the provided endpoints to: manage users, post thoughts and react to them, build friendships.

API Endpoints

Users

Friend Management

Thoughts

Reaction Management

Screenshots

Links

GitHub repository - https://github.com/Leo-webdev7/SocioLink-API Walkthrough video - https://drive.google.com/file/d/1_ZHgGtdTmX4Sd_mSBJCWyLobjG-EH-k3/view?usp=sharing

License

This application is covered under the MIT license.

Questions

Have additional questions? Click the links below to reach me through my GitHub account or Email address.

Link to GitHub

lshapirov2@gmail.com