Twitter Clone API TS

This is a Twitter clone project built with NestJS and TypeScript.

Description

The Twitter Clone is a web application that aims to replicate some of the core features and functionality of the popular social media platform, Twitter. It provides a platform for users to post tweets, users, and more.

The project is built with NestJS, a progressive Node.js framework for building efficient, scalable, and maintainable server-side applications. NestJS leverages TypeScript, providing strong typing and enhanced tooling for better developer experience.

Features

• User registration and authentication
• User profiles with bio
• Posting tweets with text

Installation

1. Clone the repository:

   git clone https://github.com/BaseMax/TwitterCloneAPITS.git

2. Navigate to the project directory:

   cd TwitterCloneAPITS

3. Install the dependencies:

   npm install

4. Create a .env file in the root directory and provide the necessary configuration variables. You can use the .env.example file as a template.

5. Set up the database by running the migrations:

   npm run migration:run

Usage

Start the application:

npm run start:dev

Access the application in your browser at http://localhost:3000.

Use the provided API endpoints to interact with the Twitter Clone, or explore the application's user interface.

API Endpoints

Here's an example of a list of API routes that could be included in a Twitter clone project:

• POST /api/auth/register: Register a new user account.
• POST /api/auth/login: Log in an existing user.
• GET /api/auth/logout: Log out the currently authenticated user.
• GET /api/users: Get a list of all users.
• GET /api/users/:id: Get the details of a specific user by ID.
• PUT /api/users/:id: Update the profile information of a specific user by ID.
• GET /api/tweets: Get a list of all tweets.
• GET /api/tweets/:id: Get the details of a specific tweet by ID.
• POST /api/tweets: Create a new tweet.
• PUT /api/tweets/:id: Update the content of a specific tweet by ID.

API Examples

Here are some examples of how the API routes could be used in a Twitter clone project:

POST /api/auth/register: Register a new user account.

Request Body:

{
  "username": "john_doe",
  "email": "[email protected]",
  "password": "password123"
}

Response:

{
  "id": "1",
  "username": "john_doe",
  "email": "[email protected]"
}

POST /api/auth/login: Log in an existing user.

Request Body:

{
  "username": "john_doe",
  "password": "password123"
}

Response:

{
  "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": "1",
    "username": "john_doe",
    "email": "[email protected]"
  }
}

GET /api/auth/logout: Log out the currently authenticated user.

Response:

{
  "message": "Logged out successfully"
}

GET /api/users: Get a list of all users.

Response:

[
  {
    "id": "1",
    "username": "john_doe",
    "email": "[email protected]"
  },
  {
    "id": "2",
    "username": "jane_smith",
    "email": "[email protected]"
  }
]

GET /api/users/:id: Get the details of a specific user by ID.

Response:

{
  "id": "1",
  "username": "john_doe",
  "email": "[email protected]"
}

PUT /api/users/:id: Update the profile information of a specific user by ID.

Request Body:

{
  "username": "john_doe_updated",
  "bio": "Software Developer"
}

Response:

{
  "id": "1",
  "username": "john_doe_updated",
  "email": "[email protected]",
  "bio": "Software Developer"
}

GET /api/tweets: Get a list of all tweets.

Response:

[
  {
    "id": "1",
    "author": {
      "id": "1",
      "username": "john_doe"
    },
    "content": "Hello, Twitter!"
  },
  {
    "id": "2",
    "author": {
      "id": "2",
      "username": "jane_smith"
    },
    "content": "Tweeting away!"
  }
]

GET /api/tweets/:id: Get the details of a specific tweet by ID.

Response:

{
  "id": "1",
  "author": {
    "id": "1",
    "username": "john_doe"
  },
  "content": "Hello, Twitter!"
}

POST /api/tweets: Create a new tweet.

Request Body:

{
  "content": "My first tweet!"
}

Response:

{
  "id": "3",
  "author": {
    "id": "1",
    "username": "john_doe"
  },
  "content": "My first tweet!"
}

Contributing

Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.

License

This project is licensed under the GPL-3.0 License.

Copyright 2023, Max Base