Technologies used in the project:
- React
- TailWind CSS
- NodeJs
Sure, here is a possible readme for the "icare-app" repository:
iCare is a web-based CRM (Customer Relationship Management) application designed to help companies manage their inventory and employees efficiently. It provides a user-friendly interface for users to perform various tasks related to inventory management, employee management, sales, and reporting.
- Inventory Management: Track inventory levels, manage purchase orders, and view sales data.
- Employee Management: Manage employee data, including personal information, attendance, payroll, and benefits.
- Sales Management: Track sales and generate reports on sales data.
- Reporting: Generate reports on inventory, employee, and sales data.
Before running the application, you need to have the following software installed on your computer:
- Node.js (v12.0 or later)
- MongoDB
To install the application, follow these steps:
- Clone the repository:
git clone https://github.com/ashinlaurel/icare-app.git
- Install the dependencies:
cd icare-app
npm install
- Configure the application:
Create a .env file in the root directory of the project and add the following environment variables:
PORT=3000
MONGODB_URI=<your-mongodb-connection-string>
SECRET=<your-secret-key>
- Start the application:
npm start
The application will be available at http://localhost:3000/.
The application is built using the following technologies:
- Node.js
- Express.js
- MongoDB
- Mongoose
- React
- Redux
Contributions to the project are always welcome. To contribute, follow these steps:
- Fork the repository.
- Create a new branch.
- Make your changes and commit them with descriptive messages.
- Push your changes to your fork.
- Create a pull request.
This project is licensed under the MIT License - see the LICENSE file for details.