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.
- The
SocMedPlat_APIapplication 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.
- 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.
- Node.js - It is recommended to download
node.js v18.16.0since this application has only been tested with that version. - MongoDb - It is recommended to download
mongoDb v6.0.6since this application has only been tested with that version.
To use the SocMedPlat_API application, first complete the following steps:
- Clone the repository:
- Go to the GitHub
- Clone the repo to your local computer.
- Navigate to the
SocMedPlat_apidirectory:
- Open a command line interface.
- Change directory to the
SocMedPlat_apirepository location. Use the commandcd ~/...and replace...with the path to theSocMedPlat_apidirectory. It is crucial to ensure that packages are installed within theSocMedPlat_apidirectory, whereserver.jsis located.
- Initialize
Node.jsmodules:
- In the command line, while in the
SocMedPlat_apidirectory, run the commandnpm i. - This command will install the required
Node.jsmodules for the application to function.
- Provide your database and server information in the
.envfile:
- Locate the
.envfile in the cloned repo. - Open the file and enter your
server portanddatabase 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.jsto start the server. - The application should now be up and running.
If there are any questions, feel free to contact my email at: ericsonhnc@gmail.com
You can also find me on GitHub at: JonathanFadera