Orion Scheduling

A simple time scheduling application that helps you and your friends find overlaps in your schedules.

Table of Contents

• Description
• Frontend Setup
• Database Setup
• Backend Setup
• Usage
• Contributing
• Credits
• License

Description

This project is an application that allows you to create a timetable to help you and your friends find common free time. Send the link to your friends, allocate free time, and find the time when you are all free.

Installation

To install this application, follow these steps:

1. Clone the repository: https://github.com/GU-Web-Dev-2024/cpsc-332-web-dev-final-project-Frolower.git
2. Navigate into the folder: cd cpsc-332-web-dev-final-project-Frolower
3. Navigate to the frontend folder: cd frontend
4. Install frontend dependencies: npm install
5. Run the frontend application: npm start

The application will be running on http://localhost:3000.

Database setup

1. Install PostgreSQL version 14 or higher:
• MacOS: https://www.pgadmin.org/download/pgadmin-4-macos/
• Windows https://www.pgadmin.org/download/pgadmin-4-windows/
2. Create a new database
3. Right click on it and choose Restore option
4. Select Custom format
5. Select the file provided in the submission
6. Click Restore

Backend Setup

To set up and run the backend, follow these steps:

1. Navigate into the project folder
2. Navigate to the backend folder: cd backend
3. Install backend dependencies: npm install
4. Create a .env file in the backend folder with the following structure:

    
      DB_USER=DB_USER
      DB_PASSWORD=DB_PASSWORD
      DB_HOST=localhost
      DB_PORT=5432
      DB_NAME=DB_NAME
      
  

5. Run the backend server: node server.js

The backend will be running on http://localhost:3001.

Usage

1. Create your timetable.
2. Select dates you want to plan for.
3. Sign in.
4. Select your free time.
5. Click "Save Availability"
6. Send a link to your friends, so they can join.
7. To update your availability click "Get Availability", update it and save it again.

Contributing

To contribute:

1. Fork the repository.
2. Create a new branch with your feature: git checkout -b feature/your-feature-name
3. Commit your changes: git commit -m "Your commit"
4. Push to your repository: git push origin feature/your-feature-name

Credits

Developer: Nikita Dubinin
Dependencies:

• React
• React Router
• Express
• PostgreSQL

License

This project is licensed under the MIT License.