Simple.Keeper

Simple.Keeper is an expense tracking application built with Next.js. It allows users to track their expenses and manage their financial activities effectively.

Tech Stack

• Framework: Next.js
• CSS: Tailwind CSS
• State Management: Redux Toolkit
• API: RTK Query
• Storybook for component development and testing
• Continuous Integration/Continuous Deployment (CI/CD)
• Code Quality Tools: Stylelint, ESLint, Prettier, Husky, Commitlint, GitHub Actions
• Node Version Manager (nvm)
• Testing: Jest, React Testing Library
• Internationalization (i18n)

Installation

1. Clone the repository.
2. Install the dependencies using the following command:

npm install

3. Create a .env file in the project root directory and provide the required environment variables. (Look to the .env.example file for reference.)

Usage

To start the development server, run the following command:

npm run dev

The application will be accessible at http://localhost:3000.

Commands

• dev: Starts the Next.js development server.
• build: Builds the Next.js application.
• start: Starts the Next.js production server.
• lint: Lints the code using ESLint.
• lint:fix: Fixes linting issues automatically.

Testing

Simple.Keeper includes comprehensive test suites to ensure code quality and stability. To run the tests, use the following command:

npm test

Contributing

Contributions are welcome! To contribute to Simple.Keeper, follow these steps:

1. Fork the repository.
2. Create a new branch.
3. Make your changes and commit them.
4. Push the changes to your fork.
5. Submit a pull request.

License

This project is licensed under the MIT License.

Credits

Simple.Keeper is built and maintained by the contributors.