Skip to content

sayyedarib/DonorLink

Repository files navigation

DonorLink

This is the frontend repository for DonorLink, a web application built with Next.js.

Open Source Love svg1 PRs Welcome GitHub forks GitHub Repo stars GitHub contributors GitHub last commit GitHub repo size License GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests


Table of Contents
  1. Getting Started 📌
  2. Grabtern Email Feature
  3. Prettier lint Test
  4. How to contribute?
  5. Author
  6. License
  7. Our Contributors

Getting Started

How To SetUp

To get started with Grabtern Frontend, you'll need to install Node.js and npm on your machine. Then, you can clone this repository and install the dependencies:

  • Fork The Repo
you can do this by clicking on the green coloured fork button
  • Clone your forked repo
$ git clone https://github.com/<your-username>/grabtern-frontend.git
  • Go to directory
cd DonorLink
  • Install Dependencies
npm install
  • Create .env.local file in root directory
NEXT_PUBLIC_BACKEND_URL = https://donor-link-server.vercel.app
NEXT_PUBLIC_FRONTEND_URL = http://localhost:3000
NEXT_PUBLIC_GOOGLE_CLIENT_ID = you can get this id from google cloud console, it's needed only to enable google sigin in feature
  • Start LocalHost Server
npm run dev

This will start the development server on http://localhost:3000/.


  • And if server stop then

npm run build

npm start

This will start server

🧰 Tech Stack Used

NewLogo NewLogo

DonorLink Email Feature

Our platform's email service is seamlessly integrated into various sections, enhancing communication and user interaction.

While the backend remains concealed for security, accessing emails is easy with specific credentials.

You can create an account, verify it, and also act as a volunteer with verification.

This way, contributors can fully experience our platform by registering as both Volunteer and Donors.

Login to ethereal mail.com with these credentials:

"user": "[email protected]",
"password": "5w3dSkuKT1XrxMBGEY"

🧪 Prettier lint test and How to fix it?

Prettier is a code formatter that helps maintain consistent code style and formatting in your projects. It automatically analyzes your code and applies predefined formatting rules to ensure a standardized appearance.

Linting is the process of analyzing code for potential errors, bugs, and code style violations. It helps identify and highlight problematic code patterns, potential bugs, and adherence to coding standards.

<b>"Prettier lint test" </b> refers to running a linter (such as ESLint) with the Prettier plugin or rules enabled. It means checking your code for both linting errors and code formatting inconsistencies according to Prettier's rules.

To enable automatic code formatting upon saving in Visual Studio Code, you can install the Prettier extension. This extension ensures that your code is consistently formatted and adheres to the defined style guidelines. Once installed, Prettier will format your code automatically whenever you save a file.

In case you prefer not to install the Prettier extension, there are two helpful commands you can use:

  1. npx prettier --check ..: This command checks your codebase for any formatting issues without making any changes. It identifies areas where the formatting may not align with the defined rules.
  2. npx prettier --write . .: This command automatically fixes the formatting issues in your codebase. It applies the appropriate formatting changes to ensure consistency and adherence to the defined style guidelines. By utilizing these commands, you can easily verify the formatting of your codebase and address any inconsistencies or style violations, even without having the Prettier extension installed.

Contributing

If you'd like to contribute to DonorLink:-

  • If you have suggestions for adding or removing projects, feel free to open an issue to discuss it, or directly create a pull request after you edit the README.md file with necessary changes.
  • Please make sure you check your spelling and grammar.
  • Create individual PR for each suggestion.
  • Please also read through the Code Of Conduct before posting your first idea as well.

Creating A Pull Request

  1. Fork the Project

  2. Create your Feature Branch

    git checkout -b <new_branch_name>

  3. Save your changes

    git add .

  4. Commit your Changes

    git commit -m 'Added some AmazingFeature'

  5. Push to the Branch

    git push origin <branch_name>

  6. Open a Pull Request


✨ Thank You for Your Contribution!


License

This project is licensed under the MIT License - see the LICENSE file for details. MIT

Author

Sayyed Arib Hussain

Show some ❤️ by 🌟 this awesome repository!

About

User friendly platform that connects donors , volunteers and people in need

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •