FinancePro
Welcome to the Financial Tracker! This is a React-based application designed to help users manage their finances. With features for account creation and login via Firebase, this app provides a robust solution for financial tracking.
Features
- Account Creation: Users can create an account and securely log in using Firebase Authentication.
- Financial Management: Track expenses, income, and other financial metrics.
Screenshots
Getting Started
Prerequisites
To run this project locally, you need the following installed on your machine:
- Node.js (includes npm)
- Firebase CLI (for Firebase services)
Clone the Repository
First, clone the repository to your local machine:
git clone https://github.com/yourusername/financial-tracker.git cd financial-tracker
Install Dependencies
npm install
or
yarn install
Configure Firebase
To use Firebase Authentication, you need to set up Firebase in your project:
- Go to the Firebase Console
- Create a new firebase project or use an existing one
- Register your app with Firebase and get your Firebase configuration details (API key, project ID, etc.).
- Create a .env file in the root of your project and add the following environment variables with your Firebase credentials:
REACT_APP_FIREBASE_API_KEY=your-api-key REACT_APP_FIREBASE_AUTH_DOMAIN=your-auth-domain REACT_APP_FIREBASE_PROJECT_ID=your-project-id REACT_APP_FIREBASE_STORAGE_BUCKET=your-storage-bucket REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your-messaging-sender-id REACT_APP_FIREBASE_APP_ID=your-app-id
- get a FINNHUB API key at Finhub
- Add to the .env file:
REACT_APP_INVESTMENTS_KEY=your-api-key
Run the Development Server
Start the development server to see the application in action:
npm start
or
yarn start
Open your browser and navigate to http://localhost:3000 to view the application.
Contributing
If you’d like to contribute to the project, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or fix.
- Make your changes and commit them with descriptive messages.
- Push your branch to GitHub.
- Open a pull request describing your changes.
Licence
This project is licensed under the Creative Commons Licence