Thesis and Periodical Management System

Project Overview

The Thesis and Periodical Management System is a web application designed to streamline the management of theses and periodicals. This system uses React as the frontend framework, TypeScript for the backend logic, Firebase for storage and authentication, and Vite for a faster development experience. The project is currently under development and not yet deployed.

Features

• Role-based authentication (Guest, Student, Admin, Librarian)
• Dashboard for viewing theses and periodicals
• PDF upload feature
• AI chatbot for summarizing, explaining, and searching PDF files (under development)

Prerequisites

To set up the project, you need the following:

• Node.js (v16 or higher)
• npm (v7 or higher)

How to Install Node.js and npm

1. Visit the official Node.js website.
2. Download and run the installer for your operating system (Windows, macOS, or Linux).
3. Follow the installation prompts.
4. Verify the installation by opening your terminal and running:

   node -v
   npm -v

   These commands should display the installed versions of Node.js and npm.

For more guidance on setting up TypeScript, refer to this guide.

Getting Started

Clone the Repository

1. Open your terminal.
2. Run the following commands:

   git clone <repository-url>
   cd <repository-folder>

Install Dependencies

Run these commands to install all required npm packages:

npm install
npm install react-icons
npm uninstall react-google
npm install firebase
npm install react-router-dom

Run the Project

To start the development server, execute:

npm run dev

The application will be accessible at http://localhost:5173/.

Code Guidelines

• Follow TypeScript best practices.
• Keep features modular and reusable.
• Test all components before merging.

Contribution Workflow

1. Create a Branch:

   • Use a descriptive name for your branch, such as feature/<feature-name> or fix/<issue-description>.

   git checkout -b feature/<feature-name>

2. Commit Changes:

   • Use concise, descriptive commit messages.

   git add .
   git commit -m "Description of changes"

3. Push to Remote:

   • Push your branch to the remote repository.

   git push origin feature/<feature-name>

4. Create a Pull Request:

   • Open a pull request to the main branch for review.

5. Code Review:

   • Ensure at least one contributor reviews your code before merging.

Closing the Repository

To clone and set up the project on a new machine:

1. Clone the repository:

   git clone <repository-url>
   cd main

2. Start working as needed.

To switch branches or reset changes, ensure you don’t have uncommitted work:

git checkout main

Contributors

• Macalanda, Pia Katleya
• Ralleta, Thoby Jim
• Toquero, Angelica
• Mercado, Kevin Dale
• Barrameda, Jhoana Decarla

---

For questions or clarifications, contact any of the contributors listed above.