Push It API

A robust and secure API built with Kotlin and Spring Boot.
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact

About The Project

Push It API is a robust and secure API built with Kotlin and Spring Boot. It provides a solid foundation for building complex web applications.

Back to top

Built With

Back to top

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

• Docker
• Make (optional but recommended)

Installation

1. Clone the repo

   git clone https://github.com/n01rdev/push-it-api/

2. Build the Docker image

   make docker-up

Back to top

Usage

The Push It API provides a robust and secure backend for web applications. Here are some examples of how you can use it:

User Registration

To register a new user, send a POST request to /api/v1/security/register with the user's email and password in the request body:

curl -X POST -H "Content-Type: application/json" -d '{"email": "user@example.com", "password": "password"}' http://localhost:8080/api/v1/security/register

The API will return a JWE token which can be used for user authentication in subsequent requests.

User Authentication

To authenticate a user, include the JWE token in the Authorization header of your requests:

curl -H "Authorization: Bearer <JWE_TOKEN>" http://localhost:8080/api/v1/protected-endpoint

Replace <JWE_TOKEN> with the token you received during user registration.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of a request. In case of an error, the response will include a message providing more details about the error.

For example, if you try to register a user with an email that is already in use, the API will return a 409 Conflict status code and a message indicating that the email is already in use.

For more examples, please refer to the Documentation

Back to top

Roadmap

• Feature 1
• Feature 2
• Feature 3
  • Nested Feature

See the open issues for a full list of proposed features (and known issues).

Back to top

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Back to top

License

Distributed under the MIT License. See LICENSE.txt for more information.

Back to top

Contact

Álvaro Diago - alvarodiagoaguilar@gmail.com

Project Link: Push-It

Back to top

Acknowledgments

Back to top