Facebook-Events-iCal-Converter/readme.MD

[![Build Status](https://travis-ci.com/comatory/fb2iCal.svg?branch=master)](https://travis-ci.com/comatory/fb2iCal)

# fb2iCal

![fb2iCal animated gif of the app](./docs/app-preview.gif)

This app allows you to download *iCal* calendar files from Facebook URL / event number.

You can use it as a service at [https://fb2ical.com](https://fb2ical.com) or use this repository to launch your own instance.

The page that is served by the app uses a service worker and can be used offline and installed as PWA (Progressive Web App).

The site can run and download ICS file without JavaScript just fine. When JS is enabled, the server only downloads HTML file, parsing and creation of iCal file is performed inside the browser. The results will be same for both JS-enabed / disabled approach as the parser code is actually shared between browser and server.

## Development

It can run in environment with NodeJS 10 installed. It does not use Facebook API for retrieving information, instead it relies on crawling and scraping event URL. This means that it can stop working or the results might not be reliable so use this at your own risk.

Run development server: `npm run start:dev`.

Run development server with debugger `npm run start:dev:inspect`.

### Static assets

The frontend / assets are built by webpack and put into `dist/` folder. These assets are then served statically.

## Deployment

The command `npm run start` will build the assets and start the server in production mode. 

The app is stateless and does not need any persistent storage.

The app is automatically set up to create logs in `logs/` directory each day but it's up to your environment if the file system is persisted.

### HTTPS

App contains middleware that will redirect all traffic to HTTPS if the requests contain header `X-FORWARDED-PROTO`. For this to work, the middleware has to be enabled by setting environment variable `ENFORCE_HTTPS` to value `1`.

There are environment variables for setting pu SSL certificate from Let's Encrypt ([acme challenge](https://letsencrypt.org/docs/challenge-types/)):

* `CERT_ENDPOINT`: endpoint without leading slash such as `.well-known/acme-challenge`
* `CERT_SECRET`

This way you can set up the endpoint that will reply with secret and this should allow you to generate key pairs.
set up travis CI 2020-07-15 20:57:38 +02:00			`[![Build Status](https://travis-ci.com/comatory/fb2iCal.svg?branch=master)](https://travis-ci.com/comatory/fb2iCal)`

add readme 2019-10-24 20:21:55 +02:00			`# fb2iCal`

add preview gif to readmer 2020-01-19 19:40:29 +01:00			`![fb2iCal animated gif of the app](./docs/app-preview.gif)`

add readme 2019-10-24 20:21:55 +02:00			`This app allows you to download iCal calendar files from Facebook URL / event number.`

fix link in readme 2019-11-05 21:35:28 +01:00			`You can use it as a service at [https://fb2ical.com](https://fb2ical.com) or use this repository to launch your own instance.`
add readme 2019-10-24 20:21:55 +02:00
			`The page that is served by the app uses a service worker and can be used offline and installed as PWA (Progressive Web App).`

update README file Add more info about the architecture and how it's built. 2020-07-17 22:45:21 +02:00			`The site can run and download ICS file without JavaScript just fine. When JS is enabled, the server only downloads HTML file, parsing and creation of iCal file is performed inside the browser. The results will be same for both JS-enabed / disabled approach as the parser code is actually shared between browser and server.`

add readme 2019-10-24 20:21:55 +02:00			`## Development`

			`It can run in environment with NodeJS 10 installed. It does not use Facebook API for retrieving information, instead it relies on crawling and scraping event URL. This means that it can stop working or the results might not be reliable so use this at your own risk.`

			Run development server: `npm run start:dev`.

			Run development server with debugger `npm run start:dev:inspect`.

add Github link, update About section 2019-10-24 20:45:34 +02:00			`### Static assets`

update README file Add more info about the architecture and how it's built. 2020-07-17 22:45:21 +02:00			The frontend / assets are built by webpack and put into `dist/` folder. These assets are then served statically.
add Github link, update About section 2019-10-24 20:45:34 +02:00
add readme 2019-10-24 20:21:55 +02:00			`## Deployment`

update README file Add more info about the architecture and how it's built. 2020-07-17 22:45:21 +02:00			The command `npm run start` will build the assets and start the server in production mode.
add readme 2019-10-24 20:21:55 +02:00
update README file Add more info about the architecture and how it's built. 2020-07-17 22:45:21 +02:00			`The app is stateless and does not need any persistent storage.`
add readme 2019-10-24 20:21:55 +02:00
			The app is automatically set up to create logs in `logs/` directory each day but it's up to your environment if the file system is persisted.

			`### HTTPS`

Do not use HTTPS application routing by default, make it optional via env variable. 2019-11-04 20:12:24 +01:00			App contains middleware that will redirect all traffic to HTTPS if the requests contain header `X-FORWARDED-PROTO`. For this to work, the middleware has to be enabled by setting environment variable `ENFORCE_HTTPS` to value `1`.
add readme 2019-10-24 20:21:55 +02:00
update README with new service URL 2019-11-05 20:03:35 +01:00			`There are environment variables for setting pu SSL certificate from Let's Encrypt ([acme challenge](https://letsencrypt.org/docs/challenge-types/)):`

			* `CERT_ENDPOINT`: endpoint without leading slash such as `.well-known/acme-challenge`
			* `CERT_SECRET`
add readme 2019-10-24 20:21:55 +02:00
			`This way you can set up the endpoint that will reply with secret and this should allow you to generate key pairs.`