Skip to content

Commit bc6c87b

Browse files
docs: readme updated
1 parent 5044cf4 commit bc6c87b

File tree

1 file changed

+52
-42
lines changed

1 file changed

+52
-42
lines changed

README.md

+52-42
Original file line numberDiff line numberDiff line change
@@ -2,44 +2,51 @@
22

33
![Homepage](/images/app.png)
44

5-
## Our Mission
5+
## Mission
66

7-
Our mission is to simplify the process of calculating gold prices for jewellers and customers alike. We aim to provide a user-friendly tool that allows for accurate and efficient calculations, ensuring transparency and trust in every transaction.
7+
Our goal is to simplify the process of calculating gold prices for jewelers and customers alike. We aim to provide a user-friendly, accurate, and efficient tool for gold price calculations. By ensuring transparency and trust in every transaction, we help users make informed decisions and streamline their billing processes.
88

99
## Features
1010

11-
- Real-time Price Calculation
12-
- Transaction History
13-
- Multi Level Authentication
14-
- User-friendly Interface
15-
- Customizable Charges
16-
- Responsive Design
17-
- Secure Data Handling
18-
- Business Customization
11+
- **Real-time Price Calculation:** Provides immediate and accurate estimates for gold prices based on user inputs.
12+
- **Transaction History:** Maintains a detailed log of all transactions for easy tracking and reference.
13+
- **Multi-Level Authentication:** Implements secure login with distinct roles for different user types (e.g., admin, manager, customer).
14+
- **User-Friendly Interface:** Designed with an intuitive layout for easy navigation and use.
15+
- **Customizable Charges:** Allows users to adjust service charges, taxes, and other fees according to their needs.
16+
- **Responsive Design:** Ensures the application is fully functional on various devices, including desktops, tablets, and smartphones.
17+
- **Secure Data Handling:** Protects sensitive information with robust security measures.
18+
- **Business Customization:** Provides options for tailoring the application to specific business requirements, including currency settings and theme preferences.
1919

2020
## Demo
2121

22-
Demo is live on the the belows servers.
22+
Explore the live demo of the application on the following platforms:
2323

24-
- [Railway(Server 2)](https://goldsilverbilling-production.up.railway.app/)
25-
- [Render(Server 1)](https://goldsilverbilling.onrender.com/)
24+
- [Railway (Server 1)](https://goldsilverbilling-production.up.railway.app/)
25+
- [Render (Server 2)](https://goldsilverbilling.onrender.com/)
2626

2727
## Building and Running the Docker Container
2828

29-
1. **Build the Docker image:**
29+
To get the application up and running using Docker, follow these steps:
3030

31-
```bash
32-
docker build -t goldsilverbilling .
33-
```
31+
1. **Build the Docker Image:**
3432

35-
2. **Run the Docker container:**
33+
```bash
34+
docker build -t goldsilverbilling .
35+
```
3636

37-
```bash
38-
docker run -p 5000:5000 goldsilverbilling
39-
```
37+
This command creates a Docker image named `goldsilverbilling` based on the Dockerfile in the project directory.
4038

39+
2. **Run the Docker Container:**
4140

42-
## Product Screenshots
41+
```bash
42+
docker run -p 5000:5000 goldsilverbilling
43+
```
44+
45+
This command runs a container from the `goldsilverbilling` image and maps port 5000 of the container to port 5000 on your host machine.
46+
47+
## Screenshots
48+
49+
Here are some screenshots of the application:
4350

4451
### Homepage
4552

@@ -56,24 +63,25 @@ docker run -p 5000:5000 goldsilverbilling
5663
### System Settings
5764

5865
![System Settings](/images/system_setting.png)
59-
66+
6067
### Transaction History
6168

6269
![Transaction History](/images/transaction_history.png)
6370

64-
## Improvements
71+
## Planned Improvements
6572

66-
| Improvement | Type | Details | Implemented |
67-
|------------------------|-----------------------|-------------------------------------------------------------------------------------------|--------------|
68-
| User Authentication | Security | Add a login system to secure sensitive data. | ☑ |
69-
| Data Persistence | Functionality | Store historical data for future reference. | ☑ |
70-
| Multi-Currency Support | Functionality | Allow conversions for different currencies. | ☑ |
71-
| Responsive Design | User Experience | Enhance mobile usability by optimizing the layout and design for smaller screens. | ☑ |
72-
| Error Handling | Functionality | Implement robust validation and error messages for user inputs to improve user experience. |☑ |
73-
| API Integration | Integration | Fetch real-time gold/silver prices from external APIs. | :x: |
74-
| Advanced Analytics | Functionality | Provide reports or graphs based on past transactions for better insights. | :x: |
75-
| Multi-Language Support | User Experience | Cater to a broader audience by including multiple languages for the user interface. | :x: |
73+
We are continually working on enhancing the application. Here are some planned improvements:
7674

75+
| Improvement | Type | Details | Status |
76+
|------------------------|-----------------------|-------------------------------------------------------------------------------------------|--------|
77+
| **User Authentication** | Security | Implement a robust login system to secure sensitive data and restrict access based on user roles. ||
78+
| **Data Persistence** | Functionality | Ensure historical data is stored and easily retrievable for future reference. ||
79+
| **Multi-Currency Support** | Functionality | Introduce support for multiple currencies to allow users to perform conversions and calculations in different currencies. ||
80+
| **Responsive Design** | User Experience | Enhance the design and layout for improved usability on mobile and tablet devices. ||
81+
| **Error Handling** | Functionality | Implement comprehensive validation and error messaging to improve user experience and data integrity. ||
82+
| **API Integration** | Integration | Integrate external APIs to fetch real-time gold and silver prices. | :x: |
83+
| **Advanced Analytics** | Functionality | Develop features to generate detailed reports and visualizations based on transaction data. | :x: |
84+
| **Multi-Language Support** | User Experience | Add support for multiple languages to cater to a wider audience and enhance accessibility. | :x: |
7785

7886
## Author
7987

@@ -85,15 +93,17 @@ This project is open source and available under the [MIT License](LICENSE).
8593

8694
## Acknowledgments
8795

88-
- [Font Awesome](https://fontawesome.com/)
89-
- [Bootstrap](https://getbootstrap.com/)
90-
- [Python](https://www.python.org/)
91-
- [Flask](https://flask.palletsprojects.com/)
92-
- [Render](https://render.com/)
93-
- [Railway](https://railway.app/)
96+
We'd like to acknowledge the following tools and libraries that have been instrumental in developing this project:
97+
98+
- [Python](https://www.python.org/) - The programming language used for the backend.
99+
- [Flask](https://flask.palletsprojects.com/) - The web framework used for building the application.
100+
- [Font Awesome](https://fontawesome.com/) - For icons and graphical elements.
101+
- [Bootstrap](https://getbootstrap.com/) - For responsive design and styling.
102+
- [Render](https://render.com/) - For hosting the application on the web.
103+
- [Railway](https://railway.app/) - For additional hosting services.
94104
95105
## Contact
96106
97-
For any queries or feedback, please feel free to reach out to us at [[email protected]](mailto:[email protected]).
107+
For any questions, feedback, or suggestions, please reach out to us at [[email protected]](mailto:[email protected]).
98108
99-
---
109+
---

0 commit comments

Comments
 (0)