AcadMap

A platform to share and explore academic resources built for students of IIT Bhilai.

Explore the docs »

View Full Site · Report Bug · Request Feature

About The Project

AcadMap is a collaborative tool designed to simplify resource sharing among students of IIT Bhilai. It allows students to contribute course materials, notes, and other valuable insights, fostering a sense of academic community.

Key Features:

• Easy upload and download of materials.
• Search and filter by courses and topics.
• OAuth-based authentication for security and privacy.

Built With

Getting Started

Follow these instructions to set up the project locally.

Prerequisites

• Install npm:

  npm install npm@latest -g

Installation

1. Clone the repository:

   git clone https://github.com/amaydixit11/acadmap.git

2. Install dependencies:

   npm install

3. Set up environment variables in .env:

    NEXT_PUBLIC_SUPABASE_URL=your_supabase_url
    NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
    NEXT_PUBLIC_GITHUB_TOKEN=your-GITHUB_TOKEN
    NEXT_PUBLIC_GITHUB_USERNAME=your-GITHUB_USERNAME
    NEXT_PUBLIC_GITHUB_ORG=your-GITHUB_ORG
    NEXT_PUBLIC_ORIGIN=website-url-deployed

4. Start the development server:

   npm run dev

Usage

Log in using your IIT Bhilai credentials, browse through shared resources, or upload your own. The platform encourages peer-to-peer learning and academic growth.

For more detailed usage instructions, refer to the Documentation.

Roadmap

• Responsive Design
• File Upload and Download
• Add Dark Mode
• Add Upload Context
• Implement Users
• Enable User Profiles
• Introduce Gamification (e.g., Contributor Badges)
• Implement Search Bar in Header
• Add Upvote Features For Resources
• Expand Features for Group Discussions

See the open issues for more details on future developments.

Contributing

Contributions are highly welcomed! Follow these steps to contribute:

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/<feature_name>).
3. Commit your changes (git commit -m "Add <feature_name>").
4. Push to the branch (git push origin feature/<feature_name>).
5. Open a pull request.

Don’t forget to star the repository if you find it useful!

License

This project is licensed under the MIT License. See the LICENSE for more details.

Contact

Amay Dixit - GitHub Profile Project Link: https://github.com/amaydixit11/acadmap

Acknowledgments

• Thanks to all the contributors who made this project possible.
• Resources:
  • Supabase Documentation
  • Next.js Documentation