makaut_buddy

KO | EN

gitlite — search

#javascript #hacktoberfest #react #ai #typescript #docker #windows #awesome #cli #kubernetes #vue #openai #mcp #open-source

(★ 37)

This project provides study material for college students.

makaut_buddy Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![image](https://raw.githubusercontent.com/Arindam200/makaut_buddy/master/public/Readme.png)

<h1 align="center"> Makaut Buddy </h1>
<p align="center">
<a href="https://github.com/Arindam200/makaut_buddy" alt="GitHub contributors">
<img src="https://img.shields.io/github/contributors/Arindam200/makaut_buddy.svg" /><a>
<a href="https://github.com/Arindam200/makaut_buddy" alt="GitHub issues by-label">
<img src="https://img.shields.io/github/issues/Arindam200/makaut_buddy" /></a>
<a href="https://twitter.com/Arindam_1729" alt="Twitter Follow">
<img src="https://img.shields.io/twitter/follow/Arindam_1729.svg?label=Follow" /></a>
<a href="https://github.com/Arindam200/makaut_buddy" alt="License">
<img src="https://img.shields.io/github/license/Arindam200/makaut_buddy.svg" /></a>

</p>

<p align="center">
This project provides study material for college students. Where they can get videos, notes, and PYQ in one place for their semester exams.
</p>

## Prerequisites

1. [Node.Js](https://nodejs.org/en) installed on your local machine.
2. [Clerk](https://clerk.com/) Account for authentication & authorization.
3. [Cloudinary](https://cloudinary.com/) Account
4. [MongoDB](https://www.mongodb.com/) Account for database setup.

## Local Setup

`NOTE: Commands are to be executed on Linux, Mac, and Windows(using Powershell)`

1. Clone this repo using:

```sh
git clone https://github.com/Arindam200/makaut_buddy.git
```

2. To install dependencies and clean the git repo run:

```sh
npm install
```

```sh
yarn install
```

3. Create a `.env` file in the root directory of the project. Add the following environment variables:

```sh
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY= YOUR_PUBLISHABLE_KEY
CLERK_SECRET_KEY= YOUR_CLERK_SECRET_KEY
NEXT_PUBLIC_API_URL= YOUR_API_URL
NEXT_PUBLIC_CLOUD_NAME=YOUR_CLOUDINARY_CLOUD_NAME
NEXT_PUBLIC_CLOUD_PRESET=YOUR_CLOUDINARY_CLOUD_PRESET
MONGODB_URI=YOUR_MONGODB_CONNECTION_URI
```

You can get these keys here: [Clerk](https://clerk.com/), [Cloudinary](https://cloudinary.com/).

For reference, you can check the `.env.example` file.

4. Run the development server:

```sh
npm run dev
```

###### or

```sh
yarn dev
```

5. Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

## Contributing

We welcome your contributions! All changes (even with commit access) need a pull request & thumbs-up from a core dev

We love ❤️ pull requests! Learn how to contribute in our guide: [contribution guide](/CONTRIBUTING.md).

## Thanks to all Contributors 💪

Thanks a lot for spending your time helping all-round-calculator grow. Thanks a lot! Keep rocking 🍻

makaut_buddy

makaut_buddy Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

makaut_buddy

makaut_buddy Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README