README.md

This Project is a part of

ExamTime

#Table Of Contents - Introdution - Tech Stack - Environment Variables - Installation Guide - Contributing Guidelines - Code of Conduct - Licenses - Contributors

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.

Tech Stack

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

git clone https://github.com/<your_username>/ExamTime.git

Navigate to the server directory

cd server

Install server dependencies

npm install

Start the server

npm run dev

Navigate to the client directory

cd ../client

Install client dependencies

npm install

Start the client

npm run dev

Start Contribution

Update existing branch

git checkout main
git pull origin main

Create a new branch

git checkout -b feature/my-feature

Make desired changes in code

Commit changes

git add .
git commit -m "Add feature XYZ"

Pushing changes

git push -u origin feature/my-feature

Now review the changes and you are all set to make your Pull Request 🥳

Contributing Guideline

• Read our CONTRIBUTING GUIDELINE 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

Code of Conduct

• Please note that this project is released with CODE OF CONDUCT. By participating in this project you agree to abide by its terms.

License

MIT

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