- Description
- Features
- Getting Started
- Prerequisites
- Installation
- Using the
makeCommand <-- Added section
- Usage
- Contributing
- License
- Acknowledgments
The pos is a web application designed to collect and manage data from various sources, providing users with a convenient way to access and download the data they need. This README provides an overview of the project, how to set it up, and how to use it.
- Collects and manages domestic and international data.
- Supports different data categories and sources.
- Provides a user-friendly interface for data selection and download.
- Allows customization and extension for additional data sources.
Before you begin, ensure you have met the following requirements:
Open your cmd and type:
make installTo execute various tasks related to your project, you can use the make command in the Windows Command Prompt (CMD). Here's how:
-
Ensure Make is Installed:
Before using the
makecommand, ensure that it's installed on your system. You can install 'make' using Chocolatey by following the provided instructions in the Installation section. -
Open the Command Prompt:
Open the Command Prompt by pressing
Win + R, typingcmd, and pressing Enter. -
Navigate to Your Project Directory:
Use the
cdcommand to navigate to your project directory. ReplaceYourUsernameand the path to match your project's location:cd C:\Users\YourUsername\YourProjectFolder
-
Run Makefile Commands:
Run Makefile commands using the
makecommand followed by the specific target or command you want to execute. For example:make install
The available commands and their descriptions are defined in your project's Makefile.
-
Review Output:
As you execute Makefile commands, the Command Prompt will display relevant information, including task execution details and any error messages.
-
Exit the Command Prompt:
To exit the Command Prompt, either close the window or enter:
exit
Before running the application, you may need to configure certain settings:
- Configure data sources and categories in the application.
- Customize the web interface to match your branding.
To run the application, follow these steps:
-
Make sure your virtual environment is activated.
-
Start the Flask development server:
-
Access the application in your web browser at
http://localhost:5000.
Contributions are welcome! If you'd like to contribute to this project, please follow these guidelines:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them.
- Push your changes to your fork and create a pull request.
- Flask - The web framework used.
- Bootstrap - Used for styling the interface.
- FontAwesome - Used for icons.