Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/womb0comb0/gdsc-farmingdale-links-api
This initiative aims to offer a compelling alternative for GDSC communities seeking efficient means to keep their members informed.
https://github.com/womb0comb0/gdsc-farmingdale-links-api
api cheerio css express html javascript puppeteer pwa typescript vite
Last synced: 3 days ago
JSON representation
This initiative aims to offer a compelling alternative for GDSC communities seeking efficient means to keep their members informed.
- Host: GitHub
- URL: https://github.com/womb0comb0/gdsc-farmingdale-links-api
- Owner: WomB0ComB0
- License: mit
- Created: 2023-09-13T17:09:05.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-17T23:50:14.000Z (9 months ago)
- Last Synced: 2024-04-18T06:52:37.029Z (9 months ago)
- Topics: api, cheerio, css, express, html, javascript, puppeteer, pwa, typescript, vite
- Language: TypeScript
- Homepage: https://gdsc-api.onrender.com/
- Size: 1.43 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://git-scm.com/downloads)
- Node.js: [Download](https://nodejs.org/)
- npm: [Download](https://www.npmjs.com/)
## Setup & Installation
1. Clone the repository:
```bash
git clone https://github.com/GDSC-FSC/gdsc-farmingdale-links-api
```
2. Navigate to the directory:
```bash
cd gdsc-farmingdale-links-api
```
3. Install the required dependencies:
```bash
npm install
```
4. Start the server:
```bash
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](https://nodejs.org/)
- [Express.js](https://expressjs.com/)
- [Axios](https://axios-http.com/)
- [Cheerio](https://cheerio.js.org/)
### Deployment
You can use which-ever method suits you best. Personally, I used [Render](https://render.com)
[Video walkthrough on how to deploy with Render](https://www.youtube.com/watch?v=iCWZi1YeOes)
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](LICENSE) file in the repository.