Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/asim-tahir/linvoice
Linvoice is a simple invoice 📃 management application. It is powered by React, Redux and Redux Toolkit.
https://github.com/asim-tahir/linvoice
invoice jest linvoice react reactjs redux redux-toolkit typescript
Last synced: about 1 month ago
JSON representation
Linvoice is a simple invoice 📃 management application. It is powered by React, Redux and Redux Toolkit.
- Host: GitHub
- URL: https://github.com/asim-tahir/linvoice
- Owner: Asim-Tahir
- License: apache-2.0
- Created: 2021-09-08T10:54:09.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-19T21:09:21.000Z (over 2 years ago)
- Last Synced: 2023-03-06T03:03:53.878Z (almost 2 years ago)
- Topics: invoice, jest, linvoice, react, reactjs, redux, redux-toolkit, typescript
- Language: TypeScript
- Homepage:
- Size: 3.29 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Linvoice is simple invoince 📃 management application.
## Screenshot 👀
The Home Page 🏠
View the services on your invoice
Look at invoices as detailed
Add a Invoice
Add Service to Invoice
Let's talk about statistics 📈
Also have dark/light mode support 🌞/🌚
## Installation
### 1. Clone repo in your local machine
```bash
git clone https://github.com/Asim-Tahir/linvoice.git
```
```bash
git clone [email protected]:Asim-Tahir/linvoice.git
```
### 2. Install dependencies
> This project uses [yarn](https://yarnpkg.com/en/) and [yarn workspaces](https://yarnpkg.com/features/workspaces) to manage dependencies. Please make sure you have yarn installed.
```bash
yarn
```
### 3. Run the app
```bash
yarn dev
```
## Folder structure
packages/ workspace folder
This folder contains all the packages that are used in the application.
assets/ folder
├───assets
│ ├───images
│ └───styles
This folder contains all the images and core tailwindcss styles.
components/ folder
This folder contains all the components that are used in the application.
├───components
│ ├───atoms
│ │ └───a11y
│ ├───molecules
│ │ ├───cards
│ │ ├───chart
│ │ └───dashboard
│ │ └───invoice
│ │ └───table
│ ├───organisms
│ │ ├───dashboard
│ │ │ ├───invoices
│ │ │ │ └───table
│ │ │ └───services
│ │ │ └───table
│ │ └───sidebar
│ ├───pages
│ │ ├───account
│ │ └───dashboard
│ │ └───invoices
│ ├───styled
│ │ ├───atoms
│ │ │ └───typography
│ │ ├───molecules
│ │ ├───organisms
│ │ ├───pages
│ │ └───templates
│ └───templates
│ └───dashboard
context/ folder
This folder contains all the custom react context that are used in the application.
├───context
│ └───tests
hooks/ folder
This folder contains all the custom react hooks that are used in the application.
├───hooks
│ └───store
icon/ folder
This folder contains all the icons and Icon component that are used in the application.
├───icon
│ ├───icons
│ │ ├───account
│ │ ├───brand
│ │ ├───filled
│ │ └───outline
│ ├───types
│ └───Icon.tsx <- Icon component
router/ folder
This folder contains all routes and route component that are used in the application.
├───router
│ ├───routes
│ ├───types
| └───index.tsx <- Router component
store/ folder
This folder contains redux & redux-toolkit store that are used in the application. And tests for store.
├───store
│ ├───tests
│ │ ├───invoices
│ │ └───services
│ └───types
utils/ folder
└───utils
This folder contains all the utils function that are used in the application.
`other` folders
This folders contains all the other files that are used in the application.
`types` folder contain global typescript types.
`email` folder contain email templates are used for sending emails.
├───types
├───email
│ └───templates
config/ workspace folder
This folder contains all the configuration files for the application.
├───eslint-config
├───jest-config
│ ├───preset
│ │ ├───babel-jest
│ │ ├───ts-jest
│ │ └───vite
│ └───transformer
├───stylelint-config
└───tsconfig
src/ folder
This folder contains core application files. And this files is start point for application.
## Running tests
```bash
yarn workspaces foreach run test
```
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
Distributed under the Apache License. See [`LICENSE`](LICENSE) for more information.
## Credits
[Windmill Dashboard](https://github.com/estevanmaito/windmill-dashboard-react/) by [Estevan Maito](https://github.com/estevanmaito) under [MIT License](https://github.com/estevanmaito/windmill-dashboard-react/blob/master/LICENSE)
[Windmill React UI](https://github.com/estevanmaito/windmill-react-ui) by [Estevan Maito](https://github.com/estevanmaito) under [MIT License](https://github.com/estevanmaito/windmill-react-ui/blob/master/LICENSE)