Skip to content

Latest commit

 

History

History
103 lines (68 loc) · 3.71 KB

README.md

File metadata and controls

103 lines (68 loc) · 3.71 KB
Raw

Pracharya

Your Community-powered Study Buddy

forthebadge forthebadge forthebadge

About The Project

Remember the stress of cramming for exams? Textbooks overflowing with information, expensive coaching centers, and that nagging feeling you might be missing something crucial? We've all been there. But what if there was a solution to make exam preparation simpler, smarter, and easier? Enter Pracharya – your community-powered study buddy!

  1. Community-Sourced Notes: Learn from high-quality, moderated notes contributed by your peers.
  2. Bite-Sized Summaries: Master complex concepts with concise summaries perfect for last-minute cramming.
  3. Personalized Mock Exams: Test your knowledge with personalized mock exams based on the syllabus and community questions.
  4. Vibrant Learning Community: Connect with fellow students, share tips, and motivate each other on the path to success.
  5. Free and Accessible: All resources – from notes to tests to forums – are completely free, with unobtrusive ads keeping the platform running.

Important Links

Pracharya Launch Blog

SQL Diagram for the Database

Contribute to our Knowledge base / Notes

Getting Started

To get a local copy up and running follow these simple example steps:

Installation

  1. Clone the repo

    git clone https://github.com/sahrohit/pracharya.git

  2. Install the project dependencies

    pnpm install

  3. Rename the env.example to env.local & update you enviroment variables in all the apps.

    API_KEY = YOUR_API_KEY;

  4. Run the following commands to start the development server

    pnpm dev

After Setting Up

To initialize the project,

pnpm dev - Run project in development mode

pnpm build - Generate production build for the project

pnpm db:* - For DB Operations

For other commands, check scripts in package.json.

Built With

Typescript Postgresql Nextjs

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GNU GPL-3 License. See LICENSE for more information.