Skip to content

Commit 4fd7ced

Browse files
authored
Update README.md
1 parent bce645c commit 4fd7ced

File tree

1 file changed

+0
-133
lines changed

1 file changed

+0
-133
lines changed

README.md

Lines changed: 0 additions & 133 deletions
Original file line numberDiff line numberDiff line change
@@ -1,136 +1,3 @@
11
# Poult Dashboard
22

33
A React TypeScript application for tracking finances and inventory of a chicken farm.
4-
5-
## Features
6-
7-
- **Transaction Tracking**: Record and monitor expenses and income
8-
- **Categorization**: Organize transactions by categories (food, medicine, tools, fence, chicken purchases/sales)
9-
- **Filtering**: Filter transactions by category
10-
- **Chicken Inventory**: Track counts of hens, cocks, and chicks
11-
- **Financial Summary**: View profit, income, and expense totals
12-
- **Responsive Design**: Optimized for both mobile and desktop
13-
14-
## Tech Stack
15-
16-
- **Frontend Framework**: React with TypeScript
17-
- **Build Tool**: Vite
18-
- **Styling**: Tailwind CSS
19-
- **Routing**: React Router
20-
- **UI Components**: Shadcn UI
21-
- **Icons**: Lucide React
22-
23-
## Project Structure
24-
25-
- `src/components`: UI components (TransactionList, TransactionForm, etc.)
26-
- `src/pages`: Main application pages
27-
- `src/hooks`: Custom React hooks
28-
- `src/lib`: Utility functions
29-
30-
## Getting Started
31-
32-
### Prerequisites
33-
34-
- Node.js (v16 or higher)
35-
- npm or yarn
36-
37-
### Installation
38-
39-
```bash
40-
# Clone the repository
41-
git clone [repository-url]
42-
43-
# Navigate to project directory
44-
cd poult-dashboard
45-
46-
# Install dependencies
47-
npm install
48-
# or
49-
yarn install
50-
```
51-
52-
### Development
53-
54-
```bash
55-
# Start development server
56-
npm run dev
57-
# or
58-
yarn dev
59-
```
60-
61-
### Building for Production
62-
63-
```bash
64-
# Build the application
65-
npm run build
66-
# or
67-
yarn build
68-
```
69-
70-
## Data Structure
71-
72-
Transactions include the following properties:
73-
- `id`: Unique identifier
74-
- `type`: 'expense' or 'income'
75-
- `category`: Transaction category
76-
- `amount`: Transaction amount
77-
- `date`: Transaction date
78-
- `description`: Additional details
79-
- `quantity`: Number of chickens (for chicken transactions)
80-
- `chickenType`: 'hen', 'cock', or 'chicks' (for chicken transactions)
81-
82-
If you want to work locally using your own IDE, you can clone this repo and push changes. Pushed changes will also be reflected in Lovable.
83-
84-
The only requirement is having Node.js & npm installed - [install with nvm](https://github.com/nvm-sh/nvm#installing-and-updating)
85-
86-
Follow these steps:
87-
88-
```sh
89-
# Step 1: Clone the repository using the project's Git URL.
90-
git clone <YOUR_GIT_URL>
91-
92-
# Step 2: Navigate to the project directory.
93-
cd <YOUR_PROJECT_NAME>
94-
95-
# Step 3: Install the necessary dependencies.
96-
npm i
97-
98-
# Step 4: Start the development server with auto-reloading and an instant preview.
99-
npm run dev
100-
```
101-
102-
**Edit a file directly in GitHub**
103-
104-
- Navigate to the desired file(s).
105-
- Click the "Edit" button (pencil icon) at the top right of the file view.
106-
- Make your changes and commit the changes.
107-
108-
**Use GitHub Codespaces**
109-
110-
- Navigate to the main page of your repository.
111-
- Click on the "Code" button (green button) near the top right.
112-
- Select the "Codespaces" tab.
113-
- Click on "New codespace" to launch a new Codespace environment.
114-
- Edit files directly within the Codespace and commit and push your changes once you're done.
115-
116-
## What technologies are used for this project?
117-
118-
This project is built with:
119-
120-
- Vite
121-
- TypeScript
122-
- React
123-
- shadcn-ui
124-
- Tailwind CSS
125-
126-
## How can I deploy this project?
127-
128-
Simply open [Lovable](https://lovable.dev/projects/52e875ef-75ee-4ca9-8123-70ac76d352e1) and click on Share -> Publish.
129-
130-
## Can I connect a custom domain to my Lovable project?
131-
132-
Yes, you can!
133-
134-
To connect a domain, navigate to Project > Settings > Domains and click Connect Domain.
135-
136-
Read more here: [Setting up a custom domain](https://docs.lovable.dev/tips-tricks/custom-domain#step-by-step-guide)

0 commit comments

Comments
 (0)