Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 3.73 KB

README.md

File metadata and controls

64 lines (50 loc) · 3.73 KB
Raw

SocMedPlat_API

Welcome to SocMedPlat_API, the backend for a cutting-edge social network web application! This API is designed to facilitate seamless interactions between users, enabling them to share their thoughts, react to their friends' thoughts, and build meaningful connections through friend lists. Built with Express.js and powered by MongoDB and Mongoose, SocMedPlat API is engineered to handle large amounts of data with lightning-fast speed and utmost flexibility, making it the ideal foundation for a thriving social networking platform.

Table of Contents

General Information

  • The SocMedPlat_API application is a backend for a social network web application. It is designed to handle large amounts of data with lightning-fast speed and utmost flexibility, making it the ideal foundation for a thriving social networking platform.

Walk-through Video

DEMO VIDEO

Technologies Used

  • JavaScript - A programming language for web development and scripting.
  • MongoDb - Scalable and flexible NoSQL database for modern applications.
  • Node.js - A scalable server-side JavaScript runtime.
  • Express - Web application framework for building server-side applications.
  • mongoose - A library for Node.js applications that provides Object Data Modeling (ODM) for MongoDB.
  • dotenv - Loading environment variables from a .env file.

Installation

  • Node.js - It is recommended to download node.js v18.16.0 since this application has only been tested with that version.
  • MongoDb - It is recommended to download mongoDb v6.0.6 since this application has only been tested with that version.

To use the SocMedPlat_API application, first complete the following steps:

  1. Clone the repository:
  • Go to the GitHub
  • Clone the repo to your local computer.
  1. Navigate to the SocMedPlat_api directory:
  • Open a command line interface.
  • Change directory to the SocMedPlat_api repository location. Use the command cd ~/... and replace ... with the path to the SocMedPlat_api directory. It is crucial to ensure that packages are installed within the SocMedPlat_api directory, where server.js is located.
  1. Initialize Node.js modules:
  • In the command line, while in the SocMedPlat_api directory, run the command npm i.
  • This command will install the required Node.js modules for the application to function.
  1. Provide your database and server information in the .env file:
  • Locate the .env file in the cloned repo.
  • Open the file and enter your server port and database name, as well as any other required information.

By following this step, you will be able to provide your database and server information in the .env file, allowing the application to connect to the database and server correctly.

Start the application:

  • In the command line, type node server.js to start the server.
  • The application should now be up and running.

Questions

If there are any questions, feel free to contact my email at: ericsonhnc@gmail.com

You can also find me on GitHub at: JonathanFadera