Velocity is a full-stack e-learning platform designed to assist college students by providing a variety of study materials including notes, previous year question papers (PYQs), Syllabus, tutorials, lab files, and more. The platform also features a discussion forum where users can ask questions and receive answers, enhancing collaborative learning.
- Study Materials: Access to notes, Resume Builder, Syllabus, tutorials, lab files, and more.
- Discussion Forum: Post questions and provide answers to fellow students.
- Search Functionality: Quickly find the study materials you need.
- User Profiles: Update profile information easily.
- Themes: Choose from a variety of themes including Dark, Rose, Light, Violet, Green, Blue, etc.
- Contact Us & Feedback: Forms for user feedback and contact.
- Frontend: Next.js, TypeScript, Shadcn UI, Tailwind CSS
- Backend: PostgreSQL, Prisma, NextAuth (Google, Spotify, GitHub authentication)
- Storage: AWS S3
- Package Manager: Bun
-
Clone the repository: bash git clone https://github.com/Harshthakur24/Velocity.git cd velocity
-
Install dependencies: bash bun install
-
Set up environment variables: Create a .env file in the root directory and add your environment variables: env // Authentication Credentials
NEXTAUTH_URL= NEXTAUTH_SECRET= AUTH_GOOGLE_ID= AUTH_GOOGLE_SECRET= AUTH_GITHUB_ID= AUTH_GITHUB_SECRET= AUTH_SPOTIFY_ID= AUTH_SPOTIFY_SECRET=
// Aws credentials AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_S3_BUCKET_NAME=
AWS_REGION=
CLOUDFRONT_DOMAIN_NAME=
// Database credentials DATABASE_URL=
-
Run the development server: bash bun dev
Open http://localhost:3000 with your browser to see the result.
- Sign Up/In: Use Google, Spotify, or GitHub to authenticate.
- Browse Materials: Navigate through the available study materials.
- Participate in Forums: Engage in discussions by posting questions or answering existing ones.
- Customize Themes: Personalize your experience by selecting a preferred theme.
- Share your thoughts: Give your feedback form and tell us about yourself by adding more details in profile and contact us for any query
We welcome contributions! Please follow these steps:
- Fork the repository.
- Create a new branch: git checkout -b feature-name.
- Make your changes and commit: git commit -m 'Add some feature'.
- Push to the branch: git push origin feature-name.
- Create a pull request.
This project is licensed under the MIT License.
For any queries or feedback, please reach out via [thakur2004harsh@gmail.com]).