TheLeCrafter / buw-app-api

Official API for the Bundesumweltwettbewerbs App by TheLeCrafter

Home Page:https://buw-api.thelecrafter.dev/data

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Bundesumweltwettbewerb App Api

CodeQL
On startup the app will download the blog post content and display it nicely. The api is hosted at https://buw-api.thelecrafter.dev/data for the data and at https://buw-api.thelecrafter.dev/thumbnails/<image.png> for the images.

Building

Requirements:

  • Node JS >= 17.3.0

The project is written in TypeScript and has to be compiled to JavaScript on first use. Clone the repository and run npm run compile on first use. If you don't edit the source code you don't need it to recompile on every restart and may just use npm run start.

NOTE: You need to copy the .env.example file to .env to change the port.

Using the CLI tool to create app posts

Requirements:

  • Node JS >= 17.3.0

Clone the repository and run npm run cli. Go through all steps and copy the generated output from the console into the /public/data/app_posts.json file.

Archived

There is no need to use a custom api when you can upload the files to GitHub itself in another repository. I may unarchive it if necessary.

About

Official API for the Bundesumweltwettbewerbs App by TheLeCrafter

https://buw-api.thelecrafter.dev/data

License:MIT License


Languages

Language:JavaScript 66.1%Language:TypeScript 33.5%Language:Shell 0.4%