Get Me A Chai

Overview

Get Me A Chai is a crowdfunding platform designed specifically for developers, creators, and influencers. Our platform allows users to support their favorite projects and creators financially, helping them bring their visions to life. With intuitive design tools and a focus on simplicity,

Technologies Used

• Frontend & Backend: Next.js (JavaScript)
• Styling: Tailwind CSS
• Database: MongoDB
• Payments: Razorpay integration
• Hosting: Vercel

Getting Started

Prerequisites

• Node.js (v12.x or later)
• npm (v6.x or later) or yarn (v1.22.x or later)

Installation

1. Clone the repository:

   git clone https://github.com/namankoolwal/Get-Me-A-Chai.git
   cd get-me-a-chai

2. Install dependencies:

   npm install
   #or
   yarn install

3. Set up environment variables:

   Create a .env.local file in the root directory and add the necessary environment variables (example below):

   MONGODB_URI=your_mongodb_connection_string
   
   GITHUB_ID=<Github_ID>
   GITHUB_SECRET=<Github_Secret>
   
   GOOGLE_CLIENT_ID=<YOUR_GOOGLE_CLIENT_ID>
   GOOGLE_CLIENT_SECRET=<YOUR_GOOGLE_CLIENT_SECRET>
   
   MONGODB_URI=<YOUR_MONGODB_URI>
   
   NEXT_PUBLIC_URL=<YOUR_NEXT_PUBLIC_URL>
   NEXTAUTH_URL=<YOUR_NEXTAUTH_URL>
   NEXTAUTH_SECRET=<YOUR_SECRET>

4. Getting Started

   First, run the development server:

       npm run dev
       # or
       yarn dev
       # or
       pnpm dev
       # or
       bun dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying app/page.js. The page auto-updates as you edit the file.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Feedback and Contributions

We invite you to experience our site by using it to support or create campaigns. Your feedback is invaluable to us and helps us improve our platform. If you have any suggestions or encounter any issues, please let us know.

We welcome contributions to enhance the platform. You can add new features, fix bugs, or improve documentation. Pull requests are welcome!

How to Contribute

1. Fork the repository:

   Click on the "Fork" button at the top right of this page to create a copy of this repository under your GitHub account.

2. Clone the forked repository:

   git clone https://github.com/namankoolwal/Get-Me-A-Chai.git
   cd get-me-a-chai

3. Create a new branch:

   git checkout -b feature-branch

4. Make your changes and commit them:

   git add .
   git commit -m 'Add new feature'

5. Push to the branch:

   git push origin feature-branch

6. Open a Pull Request:

   Go to the repository on GitHub and click on the "Compare & pull request" button. Provide a clear description of your changes and submit the pull request.

Contribution Guidelines

• Ensure your code follows the project's coding standards.
• Include relevant documentation and update existing documentation if needed.
• Write clear and descriptive commit messages.
• Test your changes thoroughly before submitting a pull request.

License

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

Contact

For any questions or feedback, please reach out to us at [email protected]

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.

😀If you are reading this then Buy Me A Chai 🍵

Credit

Student stickers created by Stickers - Flaticon

Icons by Lordicon.com