Skip to content

krisnaajiep/laravel-expense-tracker-api

Repository files navigation

Laravel Expense Tracker API

An API built with Laravel that allows users to manage their expenses. It supports categorization and filtering by amount, date, and creation time. The API uses JWT (JSON Web Token) authentication powered by tymondesigns/jwt-auth. The idea and inspiration for this project came from Roadmap.sh.

Getting started guide

To start using the Expense Tracker API, you need to -

  1. Clone the repository.

    git clone https://github.com/krisnaajiep/laravel-expense-tracker-api.git
    
  2. Install dependencies.

    composer install
    
  3. Configure .env file.

    cp .env.example .env
    
  4. Generate Application Key.

    php artisan key:generate
    
  5. Generate JWT Secret.

    php artisan jwt:secret
    
  6. Migration Database.

    php artisan migrate
    
  7. Run the local server.

    php artisan serve
    
  8. Access the URL. http://localhost:8000

Authentication

The Expense Tracker API uses Bearer Token for authentication. You can generate a Expense Tracker Bearer Token by registering a new user.

You must include a Bearer Token in each request to the Expense Tracker API with the Authorization request header.

Authentication error response

If a Bearer Token is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

HTTP Status Codes

The following status codes are returned by the API depending on the success or failure of the request.

Status Code Description
200 OK The request was processed successfully.
201 Created The new resource was created successfully.
401 Unauthorized Authentication is required or the access token is invalid.
404 Not Found The requested resource was not found.
422 Unprocessable Content The server understands the request, but cannot process it due to a validation error
429 Too Many Request The client has sent too many requests in a given amount of time (rate limiting).
500 Internal Server Error An unexpected server error occurred.

Need some help?

In case you have questions or need further assistance, you can refer to the following resources:

Laravel Logo

Build Status Total Downloads Latest Stable Version License

About Laravel

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:

Laravel is accessible, powerful, and provides tools required for large, robust applications.

Learning Laravel

Laravel has the most extensive and thorough documentation and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.

You may also try the Laravel Bootcamp, where you will be guided through building a modern Laravel application from scratch.

If you don't feel like reading, Laracasts can help. Laracasts contains thousands of video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.

Laravel Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel Partners program.

Premium Partners

Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [email protected]. All security vulnerabilities will be promptly addressed.

License

The Laravel framework is open-sourced software licensed under the MIT license.