iinamelessii / forked-url-shrtnr-jedi-knights

url-shrtnr-jedi-knights created by GitHub Classroom

Jedi-Knights - URL shortener {🧪}

Students group

• Голіней Андрій [email protected]
• Гурняк Андрій [email protected]
• Курінський Вадим [email protected]
• Макарчук Вадим [email protected]
• Обух Василь [email protected]

Design document

The design document that describes architecture and implementation details of this project.

Swagger links

• Swagger link
• Swagger UI

Main scenario endpoints

1. Sign up

curl -X 'POST' \
  'http://localhost:8080/users/signup' \
  -H 'accept: */*' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "[email protected]",
  "password": "passw000rd"
}'

2. Login

curl -X 'POST' \
  'http://localhost:8080/users/signin' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "[email protected]",
  "password": "passw000rd"
}'

Example output

{
    "token": "<token>"
}

3. Create shorten URL

curl -X 'POST' \
  'http://localhost:8080/urls/shorten' \
  -H 'accept: application/json' \
  -H 'Authorization: <TOKEN FROM THE LOGIN RESPONSE>' \
  -H 'Content-Type: application/json' \
  -d '{
  "alias": "palevo",
  "uri": "https://github.com/future-stardust/url-shrtnr-palevo"
}'

4. Redirect

curl -X 'GET' \
  'http://localhost:8080/r/palevo' \
  -H 'accept: application/json'

5. List of user’s shortened links

curl -X 'GET' \
  'http://localhost:8080/urls' \
  -H 'accept: application/json' \
  -H 'Authorization:  <TOKEN FROM THE LOGIN RESPONSE>'

Example output

{
  "urls": [
    {
      "alias": "palevo",
      "original_url": "https://github.com/future-stardust/url-shrtnr-palevo"
    }
  ]
}

6. Delete shortened link

curl -X 'DELETE' \
  'http://localhost:8080/urls/palevo' \
  -H 'accept: application/json' \
  -H 'Authorization:  <TOKEN FROM THE LOGIN RESPONSE>'

Environment prerequisites

Java

This is a Java project, so you will need an environment with installed [JDK] 15. For installation, you could use:

• [sdkman] on Linux/MacOS

IDE

As IDE use [IntelliJ Idea Edu].

Checkstyle

We use [checkstyle] to ensure coding standards. To get real-time detection in IDE you could use [Checkstyle-IDEA] plugin. We use Google rules (local copy ./config/checkstyle/checkstyle.xml).

How to start development

1. Clone this repo

2. Open the project directory in IntelliJ Idea Edu

3. Configure IDE code style settings

4. Open Settings

5. Go to Editor -> Code Style -> Import Scheme

6. Import scheme from ./config/idea/intellij-java-google-style.xml