https://github.com/vb2007/vb2007.hu-api

A simple Express.js REST API for my personal website.
https://github.com/vb2007/vb2007.hu-api

api api-rest express express-js expressjs javascript node node-js nodejs nodemon npm rest rest-api restful-api typescript

Last synced: about 3 hours ago
JSON representation

A simple Express.js REST API for my personal website.

• Host: GitHub
• URL: https://github.com/vb2007/vb2007.hu-api
• Owner: vb2007
• License: agpl-3.0
• Created: 2024-09-05T16:42:17.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2026-06-22T12:44:02.000Z (13 days ago)
• Last Synced: 2026-06-22T14:25:47.498Z (13 days ago)
• Topics: api, api-rest, express, express-js, expressjs, javascript, node, node-js, nodejs, nodemon, npm, rest, rest-api, restful-api, typescript
• Language: TypeScript
• Homepage: https://vb2007.hu
• Size: 682 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# vb2007.hu-api



[![Build and Deploy](https://github.com/vb2007/vb2007.hu-api/actions/workflows/build-deploy.yml/badge.svg)](https://github.com/vb2007/vb2007.hu-api/actions/workflows/build-deploy.yml) [![Release on GitHub](https://github.com/vb2007/vb2007.hu-api/actions/workflows/gh-release.yml/badge.svg)](https://github.com/vb2007/vb2007.hu-api/actions/workflows/gh-release.yml)

[![API Unit Tests](https://github.com/vb2007/vb2007.hu-api/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/vb2007/vb2007.hu-api/actions/workflows/unit-tests.yml) [![CodeQL](https://github.com/vb2007/vb2007.hu-api/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/vb2007/vb2007.hu-api/actions/workflows/github-code-scanning/codeql)



## About

A simple API for my personal website, written with Express.js and some other packages.

This project was made for replacing the first version of my site written in PHP: [vb2007.hu-php](https://github.com/vb2007/vb2007.hu-php)

The API is mainly - but not only - used on the project's frontend: [vb2007.hu-vue](https://github.com/vb2007/vb2007.hu-vue)

## Setting up the application

### General setup

**A MongoDB database is required for running the application:**

- [OFFICIAL DOCUMENTATION](https://www.mongodb.com/docs/manual/installation/)

- [MongoDB on a Debian Linux server](./docs/db/mongodb-deb13-setup.md)

- (Was an edge case for me in the past) [MongoDB 4.4 on Raspberry Pi 4 with Debian 13](./docs/db/mongodb-pi4-deb13-setup.md)

1. Clone the repository.

2. Based on the use-case, follow either the [Dev Setup](./docs/dev-setup.md) or [Prod Setup](./docs/prod-setup.md) guide.