Giter Club home page Giter Club logo

instaclone's Introduction

How to run locally

  • Download the project

  • Add the connection string to application.properties

  • Run InstaCloneApplication.java

  • Use Postman to interact with endpoints

Description

Graded group assignment; we chose to create a Java Spring Boot API with Postgres where users can register, login, upload, download and delete images.

Features

1. User registration

Method: POST
Endpoint: /register
Body (JSON): 
{
    "username":"EXAMPLE_USER",
    "password": "EXAMPLE_PASSWORD"
}

2. User Login

Method: POST
Endpoint: /login
Body (JSON): 
{
    "username":"EXAMPLE_USER",
    "password": "EXAMPLE_PASSWORD"
}

3. Image upload

Method: POST
Endpoint: /image/upload
Body (form-data): key = image, value = an image file, e.g example.png
Header: key = Authorization, value = JWT token string

4. Image download

Method: GET
Endpoint: /image/download/{imageId}
Path-variable: e.g imageId = 13
Header: key = Authorization, value = JWT token string

5. Image deletion

Method: DELETE
Endpoint: /image/delete/{imageId}
Path-variable: e.g imageId = 13
Header: key = Authorization, value = JWT token string

6. Show a user's profile page

Method: GET
Endpoint: /profilepage/{username}
Path-variable: e.g username = "REGISTERED_USER"
Header: key = Authorization, value = JWT token string

7. Edit a user's profile page description

Method: PUT
Endpoint: /profilepage/edit/description
Body (JSON): 
{
    "description":"NEW_DESCRIPTION"
}
Header: key = Authorization, value = JWT token string

instaclone's People

Contributors

rufat-j avatar wolfgitcode avatar rimdagic avatar jfmoller avatar sebastianp85 avatar captainmorgan1992 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.