Rock Onyx Vault FastAPI Backend
This repository contains the backend for the Rock Onyx Vault project, built using FastAPI.
Introduction
Rock Onyx Vault is a platform which provides automated Vaults with various strategies to maximize your returns with low risk. The backend is built with FastAPI, a modern web framework for building APIs with Python.
Features
- Fast Performance: Rock Onyx Vault leverages FastAPI's high-performance capabilities, making it one of the fastest Python frameworks available.
- Easy to Learn: FastAPI is designed to be easy to use and learn, with great editor support and intuitive features.
- Production-Ready: The backend code is robust and ready for production use.
- Standards-Based: Rock Onyx Vault follows open standards for APIs, including OpenAPI (previously known as Swagger) and JSON Schema.
Development Guide
To contribute to Rock Onyx Vault, follow these steps:
- Clone the Repository: Start by cloning this repository to your local machine.
- Install Dependencies: Install the required dependencies using
pip install -r requirements.txt.
- Run the Development Server: Use
uvicorn main:app --reload to run the development server locally.
- Make Changes: Make your desired changes to the codebase.
- Write Tests: Ensure that your changes are covered by tests.
- Submit a Pull Request: Submit your changes as a pull request to the
main branch.
Contribute Guide
We welcome contributions from the community! If you'd like to contribute to Rock Onyx Vault, please follow these guidelines:
- Issues: Check the issue tracker for existing issues or create a new one.
- Fork the Repository: Fork this repository to your GitHub account.
- Branch Naming: Create a new branch with a descriptive name (e.g.,
feature/add-authentication).
- Code Style: Follow the PEP 8 style guide for Python code.
- Tests: Write tests for any new features or bug fixes.
- Pull Request: Submit your changes as a pull request to the
main branch.
Let's build Rock Onyx Vault together! 🚀