search

hereisSwapnil / ExamTime

Share/Download notes PDF helps during exams
https://exam-time.vercel.app
MIT License
59 stars 121 forks source link
firebase gssoc gssoc24 mongo nodejs open-source reactjs

readme

This Project is a part of

GSSoC GSSoC


ExamTime

Table Of Contents

ExamTime is a platform designed to facilitate exam preparation by providing a centralized location for sharing and downloading notes in PDF format. Whether you're a student looking for study materials or someone willing to contribute by sharing your notes, ExamTime aims to make exam preparation more efficient and collaborative.

Contributing in open source increases your opportunities to work with different projects and mentors, getting to know various insights and ideas. It is a platform where contributors grow together with a construvtive and a positive attitude. [![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)]() ![GitHub issues](https://img.shields.io/github/issues/hereisSwapnil/ExamTime) ![GitHub forks](https://img.shields.io/github/forks/hereisSwapnil/ExamTime) ![GitHub pull requests](https://img.shields.io/github/issues-pr/hereisSwapnil/ExamTime) ![GitHub Repo stars](https://img.shields.io/github/stars/hereisSwapnil/ExamTime?style=social) ![GitHub contributors](https://img.shields.io/github/contributors/hereisSwapnil/ExamTime) ![Website](https://img.shields.io/website?down_color=red&down_message=offline&up_color=blue&up_message=online&url=https://exam-time.vercel.app/)


High VoltageTech Stack




Rocket Let's get started

## Environment Variables To run this project, you will need to add the following environment variables to your `.env` file. You can refer to the `.env.dev` file located in both the server and client directories. #### For server - `PORT` - `MONGODB_URI` - `SECRET` - `ORIGIN` #### For client - `VITE_BASE_URL` ## Run Locally ### Fork the repository ### Clone the project ```bash git clone https://github.com//ExamTime.git ``` ### Navigate to the server directory ```bash cd server ``` ### Install server dependencies ```bash npm install ``` ### Start the server ```bash npm run dev ``` ### Navigate to the client directory ```bash cd ../client ``` ### Install client dependencies ```bash npm install ``` ### Start the client ```bash npm run dev ``` ## Start Contribution ### Update existing branch ```bash git checkout main git pull origin main ``` ### Create a new branch ```bash git checkout -b feature/my-feature ``` ### Make desired changes in code ### Commit changes ```bash git add . git commit -m "Add feature XYZ" ``` ### Pushing changes ```bash git push -u origin feature/my-feature ``` ### Now review the changes and you are all set to make your Pull Request 🥳

Page with Curl Contributing Guideline


- Read our [CONTRIBUTING GUIDELINE](./.github/CONTRIBUTING_GUIDELINE.md) to get all details about contributing to **ExamTime** - Learn all about development process and all information you need to contribute to our project - If you are having the basic queries make sure you checkout resources there

Handshake Code of Conduct


- Please note that this project is released with [CODE OF CONDUCT](./.github/CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
## License [MIT](https://choosealicense.com/licenses/mit/)


Red Heart Contributors


- This project thanking all the contributors for having your valuable contribution to our project - Make sure you show some love by giving ⭐ to our repository

Back to top