Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 2.68 KB

README.md

File metadata and controls

93 lines (62 loc) · 2.68 KB
Raw

image

Makaut Buddy

This project provides study material for college students. Where they can get videos, notes, and PYQ in one place for their semester exams.

Prerequisites

  1. Node.Js installed on your local machine.
  2. Clerk Account for authentication & authorization.
  3. Cloudinary Account
  4. MongoDB Account for database setup.

Local Setup

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

  1. Clone this repo using:
git clone https://github.com/Arindam200/makaut_buddy.git
  1. To install dependencies and clean the git repo run:
npm install

or

yarn install
  1. Create a .env file in the root directory of the project. Add the following environment variables:
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, Cloudinary.

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

  1. Run the development server:
npm run dev
or
yarn dev
  1. Open 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.

Thanks to all Contributors 💪

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