/tweeteroo-java

Spring project. Tweteroo API - a Twitter clone.

Primary LanguageJava

About

Java studies. Twitter clone back-end API implemented with Spring!

  • Download and run the frontend project to see it working on Tweteroo.

Getting Started

  • Have the JDK installed in your computer, if you don't have it or are having troubles doing that, follow the steps in this tutorial.
  • Install VSCode and make sure you have some extensions ready to be used, such as Extension Pack for Java and Spring Boot Extension Pack.
  • Open the application on VSCode, open the file ApiApplication.java and click on Run.
  • Now the application should be running on port 8080 and you can access it on our browser as http://localhost:8080/

How it Works

POST /api/auth/sign-up

  • Expected body

{
  username: "bobesponja",
  avatar: "https://super.abril.com.br/wp-content/uploads/2020/09/04-09_gato_SITE.jpg?quality=70&strip=info"
}

POST /api/tweets

  • Expected body

{
  username: "bobesponja",
  tweet: "eu amo o hub"
}

GET /api/tweets

  • Expected body

[
  {
    username: "bobesponja",
    avatar: "https://super.abril.com.br/wp-content/uploads/2020/09/04-09_gato_SITE.jpg?quality=70&strip=info",
    tweet: "eu amo o hub"
  }
]

  • Expected response

The last 5 posted tweets.

GET /api/tweets/USERNAME

  • Expected body

[
  {
    username: "bobesponja",
    avatar: "https://super.abril.com.br/wp-content/uploads/2020/09/04-09_gato_SITE.jpg?quality=70&strip=info",
    tweet: "eu amo o hub"
  }
]

  • Expected response

All the tweets posted by the user.

Reference Documentation

For further reference, please consider the following sections:

Guides

The following guides illustrate how to use some features concretely:

Author


Lucas Azzolini Vieira