hermy1 / scheduler-server

Group Project: A Student Scheduling App Server! A team project. This Node.js and TypeScript-powered API allows students to schedule appointments with their professors

📅 Scheduling Server

A Student Scheduling App Server! A team project(class group). This Node.js and TypeScript-powered API allows students to schedule appointments with their professors 🚀

✨ Features

✅ User Authentication: Students and professors can securely log in and access their accounts. 🔐

🗓️ Appointment Management: Create, update, and delete appointments with ease. 📆

👁️‍🗨️ View Upcoming Appointments: Keep track of your upcoming appointments effortlessly. 📅

🌐 Secure MongoDB Integration: We ensure your data is safe and scalable with MongoDB integration. 📈

🐳 Docker Support: Use Docker for easy deployment and containerization. 🐋

📋 Prerequisites

Before you begin, ensure you have met the following requirements:

• Node.js and npm installed (recommend using Node.js LTS version)
• MongoDB server running locally or accessible
• connect-mongo dependency is used to store session information in the database. if it's not working make sure you install with force flag bash npm install connect-mongo --force for now this is a temporary fix.
• Docker installed (optional)

🚀 Installation

To get started, follow these steps:

1. Clone this repository to your local machine:

   git clone https://github.com/hermy1/scheduler-server.git
   cd scheduler-server

2. Install Dependencies:

   yarn install

3. Configure Environment Variables:

   Create a .env file in the root directory by running a bash command:

   cp .env.example .env
   

   Then fill the appropriate variables in newly created .env file. for example SECRET="joweijwejwljoeijweo" NODE_ENV=development MONGO_DATABASE= add the database etc

4. Start the Server:

   yarn start:dev

📄 API Documentation

API instructions

🤝 Git Commands

Before you start follow this instructions: Step 1: Make sure you're on the master branch before you start your task.

git status

this should say something like you're: On branch master if you're not on master then do

git checkout master

Step: 2: Then run the following command:

git pull

This will pull the latest changes. Then you can do the following command to start your task:

git checkout -b feature/authentication

"feature/authentication" <<-- this would be your new branch to work on. after push it and add someone to review your code before it is merged to master branch.

Step 3: When you're done with your task.

git add .

Step 4: Commit the changes

git commit -m "Brief description of your task"

Step 3: When you're done with your task. Then push your branch.

git push feature/authentication 

📄 License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Happy scheduling! 📚📆🎉

scheduler-server's Issues

combine professor update status and summary

Combine the update status ("/update-apointment-status") route and update ( "/addSummary") summary into one thing so that I can send this information

  appointmentId: string;
  appointmentStatus: AppointmentStatus; 
  appointmentLocation: string;
  appointmentSummary: string;