Skip to content

Commit

Permalink
fix: changes for grammatical and spelling errors (#818)
Browse files Browse the repository at this point in the history
Co-authored-by: Tamal Das <[email protected]>
  • Loading branch information
HimanshuNarware and tamalCodes authored Jun 9, 2023
1 parent b25aa2b commit d02829c
Show file tree
Hide file tree
Showing 11 changed files with 59 additions and 57 deletions.
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ We are using `pre-commit hooks, linting packages` to make sure that the code is

So whenever you try and make any commit, it will automatically run the `linting` and `prettier` on the staged/changed files and if there are any errors, it will not let you commit the code until you fix those.

Some of them are automatically fixed, while some needs manual fixing.
Some of them are automatically fixed, while some need manual fixing.

---
## Issues 👮
Expand All @@ -32,7 +32,7 @@ Some of them are automatically fixed, while some needs manual fixing.
#### Creating an issue 📝

- There are different types in the issues section such as `Bug` , `Documentation` , `Feature` . You can choose, create any of the types of issues.
- In case you need to crete something else, you can use the `Other` type. Blank issues are not recommended at all.
- In case you need to create something else, you can use the `Other` type. Blank issues are not recommended at all.
- When creating an issue make sure you fill up the fields properly and also make sure that you are **not raising a duplicate issue.**
- The `labels` are used to categorize the issues and it will be auto added based on the type of issue you are creating.

Expand All @@ -41,7 +41,7 @@ Some of them are automatically fixed, while some needs manual fixing.
- Only ask to be assigned 1 issue at a time.
- **Do not** enable GitHub Actions on your fork
- You can assign yourself to an issue if you want to work on it by checking the `I am willing to work on this issue (blank for no)` checkbox.
- Incase someone else has left that box empty, you can assign yourself to that issue by commenting `I would like to work on this issue` on that issue.
- In case someone else has left that box empty, you can assign yourself to that issue by commenting `I would like to work on this issue` on that issue.
- We assign on a **first come first serve basis**.


Expand All @@ -57,7 +57,7 @@ Some of them are automatically fixed, while some needs manual fixing.

#### Creating a Pull Request 📝

- Donot raise a PR if you are not assigned to the issue. Donot try and make spam pull requests as you might be **banned** from the organization.
- Do not raise a PR if you are not assigned to the issue. Do not try and make spam pull requests as you might be **banned** from the organization.
- Whenever making a Pull request, make sure you fill up the fields properly.
- We use `Lint PR title` workflow which makes sure that the PR titles are in the correct format. If you are not sure about the format, you can check the `Pull Request Title Format` section below.

Expand Down
2 changes: 1 addition & 1 deletion rules/BackendSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You must create a `.env` file similar to [.env.example](../.env.example) file, r


## Setting up `razorpay api key`
- Head on to [Razorpay API reference](https://razorpay.com/docs/api) and Sign Up to razor pay rembember you don't need to KYC.
- Head on to [Razorpay API reference](https://razorpay.com/docs/api) and Sign Up to razor pay remember you don't need to KYC.
- Login after Signing Up then you will see this interface, you can use the test mode.

<img width="945" alt="image" src="https://github.com/tejaskh3/Milan/assets/98630752/2de85099-8167-4db2-9fc7-9d539c5bcf64">
Expand Down
2 changes: 1 addition & 1 deletion rules/CloneSetup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

- After the fork is done, you will be redirected to your forked repo.
- The next step is to clone the repo to your local storage.
- Open your termnial and enter the following command. Remember to replace `YOUR_USERNAME` with your GitHub username.
- Open your terminal and enter the following command. Remember to replace `YOUR_USERNAME` with your GitHub username.

```bash
git clone https://github.com/<YOUR_USERNAME>/Milan.git
Expand Down
73 changes: 37 additions & 36 deletions rules/FrontendSetup.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,37 @@
# Frontend Setup

Follow the below steps to setup the Frontend locally. We are using `npm` as the package manager. So make sure you have `node` and `npm` installed in your system.

**If not installed, please read [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).**
## Installing dependencies ⏳

- Open your terminal and navigate to the `Milan` directory.
- Type `npm install` to install all the dependencies.
- Once the installation is done, you can start the frontend server by typing `npm run dev`.
- This should start the frontend server on `localhost:3000`.

## Techstack overview 🌀

- We are currently using `ReactJS v18` along with `vite v3` as the frontend framework.
- We using `Twitter Bootstrap v5` for the styling.
- List of all the dependencies can be found in the `package.json` file.


## Coding standards 🔐

- We are using `ESLint` and `Prettier` for linting and formatting.
- Maintain the same coding standards as the rest of the codebase.
- Follow good naming conventions for the files, variables and functions along with proper documentation (if needed).
- We also use `husky` and `lint-staged` to run the linter and formatter before every commit. Read about this in our [Contributing Guidelines](/CONTRIBUTING.md).
- Maintain a good folder structure, incase you use anu new components or pages make sure you put them in the right folder.
- If you are using any new dependencies, make sure you mention them in the PR.
- If you are using any new Image , compress it using [online tools]("https://www.iloveimg.com/compress-image") and then use it in the project.
- **Remember**, writing readable and clean code while following the coding standards is the best thing for any developer.
## Next steps 🚀

So now you have the the frontend up and running locally. Now you can start working on the issues.

- If you don't need to modify/work on anything related to the backend, you can skip the backend setup and simply setup a `.env` file in the root.
- Inside that `.env` file you can put `VITE_MILANAPI="https://milan-server.vercel.app"`
- If you need your own backend and want to make changes there as well, you can follow [Setting up the backend locally](/rules/BackendSetup.md)
# Frontend Setup

Follow the below steps to setup the Frontend locally. We are using `npm` as the package manager. So make sure you have `node` and `npm` installed in your system.

**If not installed, please read [installation guide](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).**
## Installing dependencies ⏳

- Open your terminal and navigate to the `Milan` directory.
- Type `npm install` to install all the dependencies.
- Once the installation is done, you can start the frontend server by typing `npm run dev`.
- This should start the frontend server on `localhost:3000`.

## Techstack overview 🌀

- We are currently using `ReactJS v18` along with `vite v3` as the frontend framework.
- We using `Twitter Bootstrap v5` for the styling.
- List of all the dependencies can be found in the `package.json` file.


## Coding standards 🔐

- We are using `ESLint` and `Prettier` for linting and formatting.
- Maintain the same coding standards as the rest of the codebase.
- Follow good naming conventions for the files, variables and functions along with proper documentation (if needed).
- We also use `husky` and `lint-staged` to run the linter and formatter before every commit. Read about this in our [Contributing Guidelines](/CONTRIBUTING.md).
- Maintain a good folder structure, incase you use anu new components or pages make sure you put them in the right folder.
- If you are using any new dependencies, make sure you mention them in the PR.
- If you are using any new Image , compress it using [online tools]("https://www.iloveimg.com/compress-image") and then use it in the project.
- **Remember**, writing readable and clean code while following the coding standards is the best thing for any developer.
## Next steps 🚀

So now you have the the frontend up and running locally. Now you can start working on the issues.

- If you don't need to modify/work on anything related to the backend, you can skip the backend setup and simply setup a `.env` file in the root.
- Inside that `.env` file you can put `VITE_MILANAPI="https://milan-server.vercel.app"`
- If you need your own backend and want to make changes there as well, you can follow [Setting up the backend locally](/rules/BackendSetup.md)

4 changes: 2 additions & 2 deletions src/components/Banners/Banner.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ const Banner = () => {
<br />
MILAN
</h1>

{/* <p className="banner_header2">MILAN</p> */}
<div>
<p className="banner_header3">
We are a hub, trying to connect help and need. Join us and
make earth a better place for all to live!
make the Earth a better place for all to live!
</p>
</div>
<div className="banner_signup_btndiv">
Expand Down
4 changes: 2 additions & 2 deletions src/components/Events/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ const EventsBanner = () => {
>
<h1 className="mb-4">Check out our events!!</h1>
<p className="donate-details">
All our partnered NGOs , hosts various events be it educational,
cleaning mother earth, funding events, health camps and many more !!
All our partnered NGOs, host various events be it educational,
cleaning mother earth, funding events, health camps, and many more!!
</p>
<p>Join us at the events, and help the community !! </p>
<button
Expand Down
5 changes: 3 additions & 2 deletions src/components/Footer.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -206,10 +206,11 @@ const Footer = () => {
href="https://github.com/IAmTamal/Milan"
target="_blank"
rel="noreferrer"
className="underline-animation"
className="underline-animation"
>
here
</a>

</p>
)}
</div>
Expand Down Expand Up @@ -298,7 +299,7 @@ const Footer = () => {
Got something to report ?
</h1>
<p className="text-center mb-lg-4" style={{ color: "#d8d7d7" }}>
You can submit a report to us by filling a form below !
You can submit a report to us by filling the form below !
</p>
<div className="d-flex justify-content-center rounded mx-auto">
<button
Expand Down
8 changes: 4 additions & 4 deletions src/components/Milaninfobanner.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ const Milaninfobanner = () => {

<div>
<p className="mib_header2">
Milan connects over 1000 charities, ngos, individuals with a
Milan connects over 1000 charities, NGOs, and individuals with a
common goal - connecting help with people that needs it. You can
donate, buy for charity, share fundraising events and much more.
donate, buy for charity, share fundraising events, and much more.
</p>
</div>
</div>
Expand All @@ -60,8 +60,8 @@ const Milaninfobanner = () => {

<div>
<p className="mib_header2">
Over 80% of our funds comes directly from the love and support
you all show. We also donate directly to emergencies, natural
Over 80% of our funds come directly from the love and support
you all show. We also donate directly to emergencies and natural
disasters. Donations, small or big, can help people in need
survive.
</p>
Expand Down
4 changes: 2 additions & 2 deletions src/pages/AboutUs.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,11 @@ export default function AboutUs() {
to English means ‘conjugation’.
</p>
<p className="mt-2">
With Milan we aim at bringing all the various NGOs and donors under
With Milan ,we aim at bringing all the various NGOs and donors under
one single roof to ease the burden of going to find their
appropriate donors and the appropriate communities to donate to.
With the help of our search filters and ask platform, it becomes
easier for the people to find their right community to serve.
easier for the people to find the right community to serve.
</p>
</div>
</div>
Expand Down
4 changes: 2 additions & 2 deletions src/pages/Donate.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ const Donate = () => {
>
<h1 className="mb-4">Yes, you help live !!</h1>
<p>
Donations does play an important part as our annual funds, donations
from your ends helps thousands of unfortunate people live their
Donations do play an important part in our annual funds, donations
from your end help thousands of unfortunate people live their
lives.
</p>
<p>
Expand Down
2 changes: 1 addition & 1 deletion src/pages/shops/ShopCategory.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const ShopCategory = () => {

<p className="shop_header2">
All the products listed here, are made by our members, local
charities, NGOs, orphanages. We don't take any profit from the
charities, NGOs, and orphanages. We don't take any profit from the
sales.
</p>
</div>
Expand Down

0 comments on commit d02829c

Please sign in to comment.