GDSC Links API

This is an API that scrapes the GDSC Farmingdale events from the GDSC website and provides them in a structured JSON format.

Features

• Scrapes for GDSC events.
• Stores the events in a local JSON/js file.
• Provides an endpoint to fetch the stored events.
• Periodically updates the events (every week by default).

Prerequisites

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

• Git: Download
• Node.js: Download
• npm: Download

Setup & Installation

1. Clone the repository:

   git clone https://github.com/GDSC-FSC/gdsc-farmingdale-links-api

2. Navigate to the directory:

   cd gdsc-farmingdale-links-api

3. Install the required dependencies:

   npm install

4. Start the server:

   npm start

The server will start on http://localhost:3000.

API Endpoints

• GET /api/past-events
  • Returns the past events stored in the local JSON file.

Acknowledgements

This repository may utilize packages and dependencies from the following sources:

• Node.js
• Express.js
• Axios
• Cheerio

Deployment

You can use which-ever method suits you best. Personally, I used Render Video walkthrough on how to deploy with Render

Please make sure to review and adhere to the licenses and terms of use of these dependencies.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the terms of the MIT license. For more details, see the LICENSE file in the repository.