apod

KO | EN

gitlite — search

#javascript #python #typescript #golang #go #android #linux #docker #windows #cli #kubernetes #vue #security #pytorch

(★ 7)

Self hosted Astronomy Picture of the Day viewer

apod Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

Self hosted [NASA Astronomy Picture of the Day](https://apod.nasa.gov/apod/astropix.html) (APOD) viewer written with Ionic 8 / Angular 22 (`client`) and Java (`server`).

# https://apod.rasc.ch/

## Technology

### Server
Written in Java 25 with Spring / Spring Boot.
Periodically polls the [APOD API](https://api.nasa.gov/api.html), stores the information in a [Xodus](https://github.com/JetBrains/xodus) database, downloads the normal and high def image and recompresses them with [jpeg-recompress](https://github.com/danielgtaylor/jpeg-archive) to save bandwidth.      
Provides a Protocol Buffer endpoint (`/apods`) for the clients.

**Libraries:**
  * [Spring 7](https://spring.io/projects/spring-framework)
  * [Spring Boot 4](https://spring.io/projects/spring-boot)
  * [Xodus](https://github.com/JetBrains/xodus)
  * [jsoup](https://jsoup.org/)
  * [OkHttp](http://square.github.io/okhttp/)
  * [protobuf-java](https://github.com/google/protobuf)
  * [kryo](https://github.com/EsotericSoftware/kryo)

<br>

### Client
Written in [TypeScript](https://www.typescriptlang.org/), CSS, HTML and the [Ionic](https://ionicframework.com/) framework.    
The app consists of 3 pages:
  * **Home**: Displays a list of images for each APOD entry. Shows detail page when user taps on image.
  * **Detail**: Displays the image and underneath the explanation. Shows full page when user taps on image.
  * **Full**: Displays the high definition image in a scrollable view.
  
Apod data is stored in IndexedDB. The application accesses the IndexedDB through [Dexie.js](http://dexie.org/). Visited images are stored by the service worker in the cache. The application assets are also cached, the app therefore runs when offline. In offline mode the applications shows only entries and images that the user visited before and are therefore cached.

#### Libraries
  * [Ionic](https://ionicframework.com/)
  * [Dexie.js](http://dexie.org/)
  * [ProtoBuf.js](https://github.com/dcodeIO/ProtoBuf.js/)
  * [Workbox](https://developers.google.com/web/tools/workbox/)
  
#### Icon
Source: https://www.shareicon.net/science-stars-education-astronomy-universe-telescope-795293      
Various sized icons generated with: http://cthedot.de/icongen/

#### Build tools
  * [bread-compressor-cli](https://github.com/ralscha/bread-compressor-cli): Pre-compresses assets
  * [Vite](https://vite.dev/): Builds the custom service worker
  * [workbox-cli](https://github.com/googlechrome/workbox): Precache the application resources

## Run locally

* Install Node.js
    https://nodejs.org/en/

* Install Java 25

* Download jpeg-recompress for your operation system
    https://github.com/imagemin/jpeg-recompress-bin/tree/master/vendor/

* Clone the project and install the dependencies
    ```
    git clone https://github.com/ralscha/apod.git
    cd apod/client
    npm install
    ```

* Open `server/src/main/resources/application-development.properties` and change the path to the jpeg-recompress binary.

* Visit the NASA Open API page and apply for an API key (it's free)     
    https://api.nasa.gov/index.html#apply-for-an-api-key

* Open `server/src/main/resources/application.properties` and enter the API key     
    `app.nasa-api-key=<enter key here>`

* Download some test data. The following command will download the last 10 days.
    ```
    cd apod/server
    ./mvnw spring-boot:run -Dspring.profiles.active=development -Dspring-boot.run.arguments=import10
    ```

* Start the server
  ```
  ./mvnw spring-boot:run -Dspring.profiles.active=development
  ```

* Start the client and service worker build watcher
  ```
  cd apod/client
  npm run dev
  ```

apod

apod Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

apod

apod Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README