Merge pull request #45 from CodeChefVIT/staging

Release v1.0.0 - Initial Public Release

.env.example

@@ -9,6 +9,19 @@
 # When adding additional environment variables, the schema in "/src/env.js"
 # should be updated accordingly.
 
-# Example:
-# SERVERVAR="foo"
-# NEXT_PUBLIC_CLIENTVAR="bar"
+CLOUDINARY_API_KEY=""
+CLOUDINARY_SECRET=""
+CRYPTO_SECRET=""
+EMAIL_HOST=""
+EMAIL_PASSWORD=""
+EMAIL_PORT=""
+EMAIL_SECURE=""
+EMAIL_USER=""
+JWT_SECRET=""
+MONGODB_URI=""
+NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME=""
+NEXT_PUBLIC_CRYPTO_SECRET=""
+KV_URL=""
+KV_REST_API_URL=""
+KV_REST_API_TOKEN=""
+KV_REST_API_READ_ONLY_TOKEN=""

CONTRIBUTING.md

@@ -0,0 +1,72 @@
+## Contribution Guidelines
+
+Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
+
+## How to contribute
+
+- Decide which repository to contribute
+- Decide what to contribute
+- Fork the repo then clone it locally
+- Commit your work (You should create a new branch when you're doing development work that is somewhat experimental in nature.)
+- Create a **Pull Request**
+- Congrats 🎉 you have just contributed towards open source!
+
+## What to contribute
+
+- Find an open issue to tackle
+- Ask if you can help write a new feature
+- Add / Improve Unit Testing
+- Write tutorials for how a project can be used and add to the readme
+- Review code on other people’s submissions and help improving / finding vulnerabilities
+
+## Making a PR
+- Provide all the appropriate details asked in PR template
+- A pull request doesn’t have to represent finished work. It’s usually better to open a pull request early on, so others can watch or give feedback on your progress. Just mark it as a “WIP” (Work in Progress) in the subject line. You can always add more commits later.
+
+## Opening an Issue
+- Make use of an appropriate Issue Template
+- We welcome Feature request, Bug Report, Documentation fix and others
+- Do not open critical security issues here, report them directly at [our email](mailto:[email protected]).
+
+## Communicating effectively
+**Give context.** Help others get quickly up to speed. If you’re running into an error, explain what you’re trying to do and how to reproduce it. If you’re suggesting a new idea, explain why you think it’d be useful to the project (not just to you!).
+
+```
+✔️ “X doesn’t happen when I do Y”
+❌ “X is broken! Please fix it.”
+```
+
+**Do your homework beforehand.** It’s OK not to know things, but show that you tried. Before asking for help, be sure to check a project’s README, documentation, issues (open or closed), mailing list, and search the internet for an answer. People will appreciate when you demonstrate that you’re trying to learn.
+
+```
+✔️ ““I’m not sure how to implement X. I checked the help docs and didn’t find any mentions.””
+❌ “How do I X?”
+```
+
+**Keep requests short and direct.**
+
+```
+✔️ “I’d like to write an API tutorial.”
+❌ “I was driving down the highway the other day and stopped for gas, and then I had this amazing idea for something we should be doing, but before I explain that, let me show you…“
+```
+
+**It’s okay to ask questions (but be patient!).**
+
+```
+✔️ “Thanks for looking into this error. I followed your suggestions. Here’s the output.”
+❌ “Why can’t you fix my problem? Isn’t this your project?”
+```
+
+**Respect community decisions.**
+
+```
+✔️ “I’m disappointed you can’t support my use case, but as you’ve explained it only affects a minor portion of users, I understand why. Thanks for listening.”
+❌ “Why won’t you support my use case? This is unacceptable!”
+```
+
+## Misc
+- You are welcome to Propose a new feature by creating an **Issue**.
+- You may Discuss a high-level topic or idea (for example, community, vision or policies) by writing to us at our [Email](mailto:[email protected]).
+
+## Attribution
+- [Open Source Guide](https://opensource.guide/how-to-contribute/)

README.md

@@ -1,29 +1,58 @@
-# Create T3 App
+<p align="center"><a href="https://www.codechefvit.com" target="_blank"><img src="https://i.ibb.co/4J9LXxS/cclogo.png" width=160 title="CodeChef-VIT" alt="Codechef-VIT"></a>
+</p>
 
-This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`.
+<h2 align="center"> Papers </h2>
+<br/>
 
-## What's next? How do I make an app with this?
+> <p>Prepare to excel in your CATs and FATs with CodeChef-VIT's dedicated repository of past exam papers. Access key resources to review concepts, tackle challenging questions, and familiarize yourself with exam patterns. Boost your confidence, sharpen your strategy, and get ready to ace your exams!</p>
 
-We try to keep this project as simple as possible, so you can start with just the scaffolding we set up for you, and add additional things later when they become necessary.
+## 🌐 Deploy
+[https://papers.codechefvit.com/](https://papers.codechefvit.com/)
 
-If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our [Discord](https://t3.gg/discord) and ask for help.
+## ⚙️ Tech Stack:
 
-- [Next.js](https://nextjs.org)
-- [NextAuth.js](https://next-auth.js.org)
-- [Prisma](https://prisma.io)
-- [Drizzle](https://orm.drizzle.team)
-- [Tailwind CSS](https://tailwindcss.com)
-- [tRPC](https://trpc.io)
+- Next.js : Framework for React applications with server-side rendering.
+- Tailwind CSS : Utility-first CSS framework for rapid UI development.
+- MongoDB & Mongoose : Database and object data modeling (ODM) for Node.js.
+- Cloudinary : Media storage and optimization service.
+- Nodemailer : Node.js library for sending emails.
+- Shadcn : Collection of pre-built components using Radix UI and Tailwind CSS.
 
-## Learn More
+## 💡 Features:
 
-To learn more about the [T3 Stack](https://create.t3.gg/), take a look at the following resources:
+- Access a vast collection of past CAT and FAT papers
+- Review papers sorted by subject, year, and difficulty
+- Download papers for offline use
+- Familiarize yourself with exam patterns and types of questions
+- Stay updated with any new additions to the repository
 
-- [Documentation](https://create.t3.gg/)
-- [Learn the T3 Stack](https://create.t3.gg/en/faq#what-learning-resources-are-currently-available) — Check out these awesome tutorials
+## 🏁 Get Started
 
-You can check out the [create-t3-app GitHub repository](https://github.com/t3-oss/create-t3-app) — your feedback and contributions are welcome!
+To get started, fork your own copy and clone the master branch. To clone a branch you can run the following:
 
-## How do I deploy this?
+```bash
+git clone -b master https://github.com/<Your username>/papers-codechef.git
+```
 
-Follow our deployment guides for [Vercel](https://create.t3.gg/en/deployment/vercel), [Netlify](https://create.t3.gg/en/deployment/netlify) and [Docker](https://create.t3.gg/en/deployment/docker) for more information.
+Run these commands on your bash/terminal and open it in a code editor of your choice.
+
+Run the following to install all the dependencies:
+
+```bash
+pnpm i
+```
+
+To start your development server run:
+
+```bash
+pnpm dev
+```
+Before getting started, please ensure that the .env file is properly configured. The .env.example file has been provided for your reference, with examples of environment variables to be  listed.
+
+## License
+
+[![License](http://img.shields.io/:license-mit-blue.svg?style=flat-square)](http://badges.mit-license.org)
+
+<p align="center">
+	Made with :heart: by <a href="https://www.codechefvit.com" target="_blank">CodeChef-VIT</a>
+</p>

package.json

@@ -24,6 +24,8 @@
     "@react-pdf-viewer/zoom": "^3.12.0",
     "@t3-oss/env-nextjs": "^0.10.1",
     "@types/mongoose": "^5.11.97",
+    "@upstash/ratelimit": "^2.0.3",
+    "@vercel/kv": "^3.0.0",
     "axios": "^1.7.2",
     "bcrypt": "^5.1.1",
     "class-variance-authority": "^0.7.0",