Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hope-ag/gra-tax
GRA-TAX: Provide your expected net income and allowances and get a detailed breakdown of your gross income, taxes, and social security contributions, based on GRA's latest tax rates.
https://github.com/hope-ag/gra-tax
binary-search express jest nodejs openapi-specification rate-limiting typescript
Last synced: about 2 months ago
JSON representation
GRA-TAX: Provide your expected net income and allowances and get a detailed breakdown of your gross income, taxes, and social security contributions, based on GRA's latest tax rates.
- Host: GitHub
- URL: https://github.com/hope-ag/gra-tax
- Owner: hope-ag
- Created: 2024-06-29T18:17:25.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-29T20:35:43.000Z (7 months ago)
- Last Synced: 2024-10-21T05:26:32.044Z (3 months ago)
- Topics: binary-search, express, jest, nodejs, openapi-specification, rate-limiting, typescript
- Language: TypeScript
- Homepage:
- Size: 140 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
API Docs(OpenAPI 3.0)
Provide your expected net income and allowances and get a detailed breakdown of your gross income, taxes, and social security contributions, based on GRA's latest tax rates.
## Features
- ⚡️ [Express JS](https://expressjs.com), [SWC](https://swc.rs), [ESLint](https://eslint.org/), [Prettier](https://prettier.io/)
- 🦾 TypeScript
- OpenAPI 3.0 [API Documentation](https://swagger.io/docs/specification/api-documentation/)
## Starting the project
### Prerequisites
- [NodeJS](https://nodejs.org) - Tested on version 20.11.0 and NPM version 10.2.4
### Steps
1. Clone the github project . This will create a `gra-test` folder in your current directory. Open it in your preferred text editor or IDE.
```bash
git clone [email protected]:hope-ag/gra-tax.git
cd gra-tax
```
2. Create a copy of [`env.example`](./env.example) and rename it to .env. Open the new [`.env`](./.env) and replace the `PORT` with your preferred port.
3. Open a terminal and install the project dependencies:
```bash
# npm
npm i
# pnpm
pnpm i
# yarn
yarn
```
4. Run the project in development mode:
```bash
# npm
npm run dev
# pnpm
pnpm run dev
# yarn
yarn dev
```
Refer to the [package.json](./package.json) for more details on testing, building and serving.