Certainly! Here's a formatted README in markdown that you can copy and use for your project documentation:
Fi-Svc-1 is a web application designed to help users manage their financial transactions and gain insights into their spending habits. It provides features such as adding transactions, viewing recent transactions, and visualizing transaction data through charts.
- Clone the repository:
git clone https://github.com/pushkarmourya/fi-svc-1.git
- Navigate to the project directory:
cd fi-svc-1
- Install dependencies:
npm install
- Create a
.env
file in the project root. - Add your database credentials to the
.env
file:DB_USERNAME=your_database_username DB_PASSWORD=your_database_password
- Start backend server:
node server.js
- Start the development server (in new Terminal):
npm start
- Open your web browser and go to http://localhost:3000 to access the application.
- Main Screen: Displays recent transactions and allows adding new transactions.
- View All Transactions: Click to see all transactions.
- Navigation: Use the header links to navigate between pages.
- Frontend: React.js, React Router, Chart.js
- Backend: Node.js, Express.js
- Database: MySQL
- Styling: CSS