PostAway

PostAway is a social media platform for sharing posts, connecting with friends, and exploring a personalized news feed.

Table of Contents

• Introduction
• Features
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Usage
• API Documentation
• Contributing
• License

Introduction

PostAway is a full-stack web application built with Node.js and Express for the backend, MongoDB for the database, and React for the frontend.

Features

• User authentication and authorization
• Create, update, and delete posts
• News feed with posts from friends
• Friendship management (send/receive requests, accept/reject)
• Comments on posts
• ...

Getting Started

Prerequisites

Make sure you have the following installed:

• Node.js
• MongoDB

Installation

1. Clone the repository:

git clone https://github.com/your-username/PostAway.git

2. Install dependencies:

   cd PostAway
   npm install

Configuration

1. Create a .env file in the root directory and configure the following:

   PORT=3200
   MONGODB_URI=mongodb://localhost:27017/postaway
   JWT_SECRET=your_jwt_secret_key
   EMAIL_USER=your_email@gmail.com
   EMAIL_PASS=your_email_password

Usage

1. Start the server:

   npm start

2. Access the application at http://localhost:3200.

API Documentation

API documentation can be found here.

Contributing

We welcome contributions! Please follow the contribution guidelines for details on how to contribute to this project.

License

This project is licensed under the CODING NINJA License - see the LICENSE file for details.

You should replace placeholder values like `your-username`, `your_jwt_secret_key`, `your_email@gmail.com`, etc., with your actual information.