SKKU Scholarship Assistant (스꾸장학비서)

Overview

SKKU Scholarship Assistant is a project designed to make it easier for Sungkyunkwan University (SKKU) students to gather and check scholarship-related notices and announcements.

• Scholarship Notice Scraping: Automatically collects scholarship notices and announcements from SKKU using Scrapy.
• Data Storage: Stores collected data in MongoDB for efficient retrieval.
• Backend API: Provides a RESTful API built with Node.js so that users can easily query scholarship information.
• Scalability: Uses Docker for convenient deployment and management.

Tech Stack

Node.js	Scrapy	MongoDB	LangChain

How to Run

Below are the steps to run both the API server and the MongoDB service in a Docker environment:

1. Create and Configure the .env File
   In the project’s root directory, create a .env file containing the following:

   MONGODB_URI=mongodb://<user>:<password>@localhost:27017/<database>

   • Replace <user>, <password>, and <database> with your actual credentials.
   • If you’re unsure about the details of the MONGODB_URI, please contact the project contributor.

2. Start Docker Containers

   docker-compose up -d

   • The -d option runs the containers in the background.
   • Once the command completes, you can verify the containers are running by using:

     docker-compose ps

3. Access the Backend Container

   docker exec -it backend bash

4. Install Dependencies
   Inside the backend container, run:

   npm install

5. Start the API Server

   node app.js

   • If the server starts correctly, you can access it in your web browser at http://localhost:8082.

How to Use Scrapy and Parsing

For detailed instructions on how to scrape and parse data, please refer to the skku_notice/README.md.

How to Test

Follow these steps to run the tests included in the project:

1. Set Up the Environment
   Ensure that your .env file is properly configured as described in the How to Run section.

2. Install Dependencies
   If you haven’t already installed the required dependencies, run:

   npm install

3. Run Tests
   Use the following command to execute all test cases:

   npm test

   This will run the tests located in the tests directory. The test results will be displayed in the terminal.

4. Check Individual Tests
   To run specific test files, use:

   npm test <test-file-name>

   Replace <test-file-name> with the actual test file path, e.g., tests/api.test.js.

5. Verify Test Results

   • Success: If all tests pass, you will see a summary indicating success.
   • Failure: If any tests fail, review the error messages and debug the corresponding test cases or implementation.

Backend Developer

2024 Fall SKKU SE CLASS 42 TEAM 10 Backend developer

Jihun Kim

Donghyun Kim

Seungjae Oh