fadamakis/vue-twitter-clone-backend

Vue Twitter Clone - Backend

A Twitter clone built with Express.js that allows users to create accounts, post tweets, follow other users, and interact with posts through likes and comments. This project aims to replicate the core functionalities of Twitter.

Table of Contents

• Vue Twitter Clone - Backend
  • Table of Contents
    • Prerequisites
    • Installation
  • Usage
  • Seeding the Database
  • Built With
  • Contributing
  • Authors
  • License

Prerequisites

What you need to install the software and how to install them.

• Node.js (developed with v21.4.0)
• pnpm (reccomended) or npm (comes with Node.js) or Yarn
• MongoDB

Installation

1. Clone the repository:

   git clone https://github.com/fadamakis/vue-twitter-clone-backend.git

2. Navigate to the project directory:

   cd vue-twitter-clone-backend

3. Install dependencies:

   pnpm install

4. Set up environment variables:

   • Copy the .env.example file to .env:

     cp .env.example .env

   • Fill in the required environment variables in the .env file.

Usage

To run the project locally, use the following command:

pnpm dev

Visit http://localhost:3000 in your browser to see the application.

Seeding the Database

If you need to seed the database with initial data, you can use the following command:

pnpm seed

Built With

• Express.js - The web framework used
• MongoDB - Database

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests.

Authors

• Fotis Adamakis - Initial work - fadamakis

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License.