https://github.com/arindam200/makaut_buddy
This project provides study material for college students.
https://github.com/arindam200/makaut_buddy
hacktoberfest hacktoberfest-accepted nextjs
Last synced: 3 months ago
JSON representation
This project provides study material for college students.
- Host: GitHub
- URL: https://github.com/arindam200/makaut_buddy
- Owner: Arindam200
- License: mit
- Created: 2023-09-22T20:29:22.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-15T07:39:57.000Z (9 months ago)
- Last Synced: 2024-09-15T10:42:28.266Z (9 months ago)
- Topics: hacktoberfest, hacktoberfest-accepted, nextjs
- Language: JavaScript
- Homepage: https://dub.sh/makaut-buddy
- Size: 6.08 MB
- Stars: 33
- Watchers: 2
- Forks: 40
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
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](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
```
or
```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 🍻
