Skip to content

Commit 07f1400

Browse files
subhamBharadwazsubhamBharadwaz
committed
docs: 📝 Readme,Code of conduct and contributing files
1 parent 61f97e9 commit 07f1400

File tree

3 files changed

+251
-22
lines changed

3 files changed

+251
-22
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
- Demonstrating empathy and kindness toward other people
21+
- Being respectful of differing opinions, viewpoints, and experiences
22+
- Giving and gracefully accepting constructive feedback
23+
- Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
- Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
- The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
- Trolling, insulting or derogatory comments, and personal or political attacks
33+
- Public or private harassment
34+
- Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
- Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## Minty - Contribution Guidelines
2+
3+
Thank you for considering contributing to this repository! We appreciate your interest and contributions to make this project better. To ensure a smooth collaboration, please review the following guidelines before making any contributions.
4+
5+
### Table of Contents
6+
7+
- [Getting Started](https://github.com/subhamBharadwaz/minty/blob/main/CONTRIBUTING.md#getting-started)
8+
- [How to Contribute](https://github.com/subhamBharadwaz/minty/blob/main/CONTRIBUTING.md/#how-to-contribute)
9+
- [Code Style](https://github.com/subhamBharadwaz/minty/blob/main/CONTRIBUTING.md#code-style)
10+
- [Reporting Issues](https://github.com/subhamBharadwaz/minty/blob/main/CONTRIBUTING.md#reporting-issues)
11+
- [Submitting Pull Requests](https://github.com/subhamBharadwaz/minty/blob/main/CONTRIBUTING.md#submitting-pull-requests)
12+
- [License](https://github.com/subhamBharadwaz/minty/blob/main/CONTRIBUTING.md#license)
13+
14+
### Getting Started
15+
16+
To get started, follow these steps:
17+
18+
1. Fork the repository.
19+
2. Clone the forked repository to your local machine.
20+
3. Set up the development environment.
21+
4. Make your changes and test them thoroughly.
22+
5. Submit a pull request (PR) with your changes.
23+
24+
### How to Contribute
25+
26+
Contributions to this repository can be made in the following ways:
27+
28+
- Reporting issues: If you encounter any bugs, issues, or have suggestions for improvements, please open an issue in the repository.
29+
- Pull requests: You can contribute to the project by submitting pull requests for bug fixes, new features, or enhancements. Please ensure your changes adhere to the code style guidelines mentioned below.
30+
31+
### Code Style
32+
33+
To maintain a consistent codebase, we follow a specific code style. Please adhere to the following guidelines when making contributions:
34+
35+
- Use descriptive variable and function names.
36+
- Follow the existing code formatting and indentation patterns.
37+
- Write clear and concise comments to improve code readability.
38+
- Avoid excessive or unnecessary code changes that are unrelated to the purpose of your contribution.
39+
40+
### Reporting Issues
41+
42+
If you encounter any issues or have suggestions, please open an issue on GitHub. When reporting issues, provide as much detail as possible, including steps to reproduce the problem and any relevant error messages or screenshots.
43+
44+
### Submitting Pull Requests
45+
46+
To contribute code to this repository, please follow these steps:
47+
48+
1. Create a new branch from the `main` branch for your changes.
49+
2. Make your code changes in the new branch.
50+
3. Test your changes thoroughly to ensure they work as expected.
51+
4. Commit your changes with clear and descriptive commit messages.
52+
5. Push your branch to your forked repository.
53+
6. Open a pull request (PR) from your branch to the `main` branch of this repository.
54+
7. Provide a detailed description of your changes in the PR, including any relevant information or context.
55+
8. Ensure that your PR adheres to the code style guidelines and passes any automated tests or checks.
56+
57+
### License
58+
59+
By contributing to this repository, you agree that your contributions will be licensed under the [LICENSE](https://github.com/subhamBharadwaz/minty/blob/main/LICENSE.md) file of this project.

‎README.md

Lines changed: 64 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,78 @@
1-
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
1+
# Minty: Finance Tracker Application
2+
3+
Minty is a comprehensive finance tracker application designed to help users manage their financial activities efficiently. With Minty, you can track transactions, set budgets, establish financial goals, and categorize expenses with ease. The app is built with a modern tech stack that ensures high performance and seamless user experience.
4+
5+
## Features
6+
7+
- **Transaction Management**: Add, edit, and categorize your financial transactions.
8+
- **Budget Tracking**: Set up custom budgets and monitor your spending against your budget in real time.
9+
- **Goal Setting**: Define and track your financial goals to stay on top of your saving and spending plans.
10+
- **Transaction Categories**: Organize your transactions with customizable categories for better clarity and insight.
11+
- **Visual Analytics**: Visualize your financial data through charts and graphs to better understand spending patterns.
12+
13+
## Tech Stack
14+
15+
- **Frontend**: [Next.js](https://nextjs.org/)
16+
A React-based framework known for its server-side rendering and static site generation.
17+
- **Backend**: [Convex](https://www.convex.dev/)
18+
Convex is the open-source backend for application builders.
19+
An all-in-one platform with thoughtful, product-centric APIs.
20+
Get started
21+
- **Authentication**: [Clerk](https://clerk.com/)
22+
Provides secure, customizable authentication with built-in user management.
23+
24+
- **UI Components**: [Shadcn/ui](https://ui.shadcn.com/)
25+
Pre-built, accessible UI components for a modern and clean design.
26+
27+
- **Animations**: [Framer Motion](https://www.framer.com/motion/)
28+
Smooth and powerful animations that bring subtle shuttle effects to life.
29+
30+
- **Form Management**: [React Hook Form](https://react-hook-form.com/) & [Zod](https://zod.dev/)
31+
Efficient, schema-based form handling and validation.
232

333
## Getting Started
434

5-
First, run the development server:
35+
### Prerequisites
36+
37+
Ensure that you have bun installed:
38+
39+
- [Bun](https://bun.sh/)
40+
41+
### Installation
42+
43+
1. Clone the repository:
44+
45+
```bash
46+
git clone https://github.com/subhamBharadwaz/minty.git
47+
```
48+
49+
2. Navigate to the project folder:
650

7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
15-
```
51+
```bash
52+
cd minty
53+
```
1654

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
55+
3. Install the dependencies:
1856

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
57+
```bash
58+
bun install
59+
```
2060

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
61+
### Running the Application
2262

23-
## Learn More
63+
1. Start the development server:
2464

25-
To learn more about Next.js, take a look at the following resources:
65+
```bash
66+
bunx convex dev
67+
bun dev
68+
```
2669

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
70+
2. Open [http://localhost:3000](http://localhost:3000) in your browser to view the app.
2971

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
72+
## License
3173

32-
## Deploy on Vercel
74+
This project is licensed under the MIT License - see the [LICENSE](https://github.com/subhamBharadwaz/minty/blob/main/LICENSE.md) file for details.
3375

34-
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
76+
## Contributing
3577

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
78+
Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change.

0 commit comments

Comments
 (0)