diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..7322a6d698 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Code of Conduct + +Be respectful to others. This project follows a Contributor Covenant-style code of conduct. Harassment, hate speech, or other abusive behavior will not be tolerated. \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..6c3ed68b7c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,9 @@ +# Contributing + +Thanks for your interest in contributing to this project! + +- Fork the repository and create a feature branch +- Make your changes and commit with clear messages +- Open a pull request describing your changes + +Please keep changes focused and add tests where helpful. \ No newline at end of file diff --git a/README.md b/README.md index 5884e26a5b..5132b57831 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# coding-project-template \ No newline at end of file +# e-plantShopping + +This repository contains the e-plantShopping demo application (React + Vite) used for learning Redux and basic frontend patterns. + +Contents: +- `src/` - React source files +- `public/` - static assets +- `LICENSE` - Apache 2.0 license + +How to run locally + +1. Install dependencies: + +```powershell +npm install +``` + +2. Start dev server: + +```powershell +npm run dev +``` + +3. Open the app in the browser (typically http://localhost:5173) + +Simple interest script + +There is a helper shell script `simple-interest.sh` which calculates simple interest. + +Usage: + +```powershell +# on Unix/macOS +./simple-interest.sh