This repository contains the front end of the MERN Stack POS Application. The front end is built using React and provides the user interface for the POS system.
- Installation
- Usage
- Features
- Contributing
- Technologies Used
- Images/Screenshots
- Environment Variables
- License
-
Clone the repository:
git clone https://github.com/mesubasi/pos-app-frontend.git cd pos-app-frontend
-
Install dependencies:
npm install
-
Set up environment variables:
Create a .env file in the root of the project and add the following variables:
VITE_API_URL=http://localhost:5000/api VITE_AUTH_SECRET=your-auth-secret VITE_OTHER_CONFIG=your-other-config
-
Start the development server:
npm run dev
The application will start on
http://localhost:5173
.
- Navigate to
http://localhost:5173
in your web browser. - Use the provided interface to manage sales, inventory, and other POS features.
- User Authentication: Secure login and registration.
- Inventory Management: Add, update, and delete inventory items.
- Sales Management: Track and manage sales transactions.
- Reports: Generate sales and inventory reports.
- React
- Vite
- Redux
- React Router
- Ant Design
- Tailwind CSS
- Google Fonts
Here are some screenshots of the application:
Contributions are welcome! Please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature-branch
). - Make your changes.
- Commit your changes (
git commit -m 'Add new feature'
). - Push to the branch (
git push origin feature-branch
). - Open a Pull Request.
The following environment variables are required for the application to run:
- VITE_API_URL: The base URL for the API.
- VITE_AUTH_SECRET: The secret key for authentication.
- VITE_OTHER_CONFIG: Any other configuration needed.
This project is licensed under the MIT License. See the LICENSE file for details.