/revenut-api

An API that delivers RESTful endpoints to power the SaaS analytics web + mobile app Revenut

Primary LanguagePythonApache License 2.0Apache-2.0

revenut
Supports Expo iOS Supports Expo Android Supports Expo Web

SaaS Metrics in a Nutshell

OpenAPI | App Source Code

By Amar Kota - Hire me

revenut-api

🧐 About

This is an API project that delivers the RESTful endpoints that power the SaaS analytics web + mobile app Revenut at app.revenut.com.

Note

Please read https://github.com/hbcondo/revenut-app before getting started.

🏁 Getting Started

These instructions will get you a copy of the API up and running on your local machine for development and testing purposes.

Prerequisites

Installation

git clone https://github.com/hbcondo/revenut-api.git
cd revenut-api
virtulenv env
source env/bin/activate
pip install -r requirements.txt
hypercorn app/main:app --reload

Environment variables

Create an .env file in the root with these keys:

  • STRIPE_API_KEY
  • STRIPE_CLIENT_ID
  • STRIPE_ACCOUNT_ID (optional)

🔧 Running the tests

(.venv) revenut-api % pytest
=========================== test session starts ===========================
platform darwin -- Python 3.11.4, pytest-7.4.0, pluggy-1.2.0
rootdir: /revenut-api
plugins: anyio-3.6.2
collected 2 items                                                         

app/test_main.py ..                                                 [100%]

============================ 2 passed in 0.40s ============================

⛏️ Built Using

✅ TODO

  • Error handling
  • Persistence / Cache

👪 Contributing

If you like Revenut, please star this repo or consider sponsoring. If you want to make Revenut better, feel free to submit a PR, log an issue or contact me directly.

🔖 License

The Revenut source code is made available under the Apache 2.0 license.

✍️ Authors

🎉 Acknowledgements

https://stripe.com/docs/api