Skip to content

Latest commit

 

History

History
108 lines (77 loc) · 3.31 KB

README.md

File metadata and controls

108 lines (77 loc) · 3.31 KB

SavvyVitians

[ Currently it's backend is in Railway which is not accesible due to limit plan ]

Description

Welcome to the SavvyVitian repository!, a platform designed to help engineering students excel in their academic journey. This frontend project provides an intuitive interface to access study materials, tips to pass, notes, question papers, and much more. You can also contribute to the platform by sharing your own resources to help fellow students!

Features 🧑‍💻

  • Vite: Fast build and hot module replacement.
  • TypeScript: Strongly-typed development for fewer runtime errors.
  • React: Component-based architecture for building user interfaces.
  • Backend: Express + Ts + Postgre SQL + ORM (Sequelizer) -- Currently in Railway Server
  • Responsive Design: Optimized for mobile and desktop views.

Installation 🚀

  1. Clone the repository:

    git clone https://github.com/your-username/your-repo.git

  2. Navigate to the project directory:

    cd your-repo

  3. Install dependencies:

    npm install

Development

Run the development server:

npm run dev

The application will be available at http://localhost:5173/ by default.

Key Features ✨

Search by Subject: Find study materials for your subject using an intuitive search bar.

  • Organized Resources:
    • Modules: Comprehensive subject modules.
    • Tips to Pass: Quick hacks to ace your exams.
    • Notes: Detailed explanations for tough concepts.
    • Question Papers: Practice with past year papers.
    • Contribute: Add your own resources to help others in the community.

Build

To build the project for production:

npm run build

The production-ready files will be output to the dist directory.

Problem Statement 🤌

Finding the right study materials for engineering subjects can be a hassle. It aims to solve this problem by offering:

  • Modules for every subject.
  • Tips to Pass critical exams.
  • Notes curated by students and teachers.
  • Previous Year Question Papers to practice effectively.
  • A platform for students to contribute resources and expand the collection.

Deployment 🙌

This project is optimized for deployment on platforms like Vercel. Ensure you set up the following:

  • Environment variables in the Vercel dashboard.
  • Correct build command: vite build.
  • Output directory: dist.

Environment Variables

For local development, create a .env file in the root of your project:

VITE_API_KEY=your-api-key
VITE_API_URL=https://api.example.com

In production, configure these in your deployment platform's environment settings.

Contributing

Contributions are welcome! Please fork this repository and submit a pull request.

Feel free to reach out for questions or collaborations!