OnPaper is a Tauri-based cross-platform paper trading application. The frontend is built using Tauri and integrates various backend technologies to provide a seamless trading experience. Users can simulate trading activities and manage their portfolios using real-time market data and advanced search capabilities.
- Cross-platform desktop application using Tauri+React in Vite
- User authentication and role-based access control with Firebase Authentication
- Real-time data storage using Firebase Realtime Database
- Middleware microservices using a .NET web API (details at Paper-Trading)
- Typesense search for fast querying of stock records
- Market data integration via ICICI direct breeze API and TradingView
-
Clone the Repository
git clone https://github.com/pratyush103/OnPaper.git cd OnPaper -
Install Dependencies
npm install
-
Run the Development Server
npm run dev
-
Build the Application
npm run build
- Firebase Configuration: Update the Firebase configuration in your environment settings.
- API Keys and Credentials: Ensure that all necessary API keys (Firebase, ICICI direct breeze API, Typesense) are correctly set up.
-
Starting the Application
npm run tauri
-
Accessing Features
- Authentication: Sign up or log in using Firebase Authentication.
- Trading: Simulate trades and manage your portfolio.
- Search: Use Typesense-powered search to find stocks quickly.
- Fork the repository.
- Create a new branch.
- Make your changes.
- Submit a pull request.
This project is licensed under the MIT License.
Feel free to add more details or sections as necessary. If you have any questions or need further customization, please let me know!