/imger-server

🖼️ A simple REST API server used for downloading and saving images & their data using queueing mechanism. Proj. cont. Express.js app as a backend (server). Database used in this project is SQLite. 📌

Primary LanguageTypeScript

IMGer Server 🖼️

📌 A simple REST API server used for downloading and saving images & their data using queueing mechanism. Project contains Express.js app as a backend (server). Database used in this project is SQLite.

GitHub package.json version (subfolder of monorepo) GitHub top language GitHub repo size

Features

  • Adding images links to download queue
  • Showing data about all images in the database
  • Showing data about specific image in the database
  • Displaying downloaded image as a static resource

Endpoints Documentation

📚 Documentation of all available endpoints can be found here: API Documentation

Run Locally

  • Clone repository
  git clone https://github.com/jakubcieslik99/imger-server.git

ℹ️ Instructions for running server app locally:

  • Navigate to the server directory and install dependencies
  cd imger-server
  pnpm install
  • Run server app in development mode
  pnpm run dev

Deployment

ℹ️ Instructions for building and running server app in production

  • Transpile to production build
  pnpm run build
  • Run server app in production mode
  pnpm install --prod
  pnpm run start

Environment Variables

⚙️ To run server app, you will need to add the following environment variables to your .env file

  • ENV (default already set for development)

  • PORT

  • API_URL

  • CONCURRENT_DOWNLOADS

Languages

🔤 Available API messages languages: EN

Feedback

If you have any feedback, please reach out to me at ✉️ contact@jakubcieslik.com

Authors