Skip to content

Jenil-Desai/Pixelbloom-backend

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

16 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

🎨 Pixelbloom Backend

Pixelbloom Backend is the server-side codebase for the Pixelbloom mobile application, handling user authentication, wallpaper management, and user interactions like likes and bookmarks. Built with Go and PostgreSQL, it ensures high performance and scalability.


πŸ“‘ Table of Contents

  1. Overview
  2. Technologies
  3. Packages & Libraries Used
  4. Getting Started
  5. Setup
  6. Features
  7. Demo & Screenshots
  8. Acknowledgments
  9. License

🌟 Overview

Pixelbloom Backend provides RESTful APIs for user authentication, wallpaper storage, and user interactions such as likes and bookmarks. It supports JWT-based authentication and follows best practices for API security and performance.


πŸ’» Technologies

Technology Description
Go Backend logic and API development
PostgreSQL Database management

πŸ“¦ Packages / Libraries Used

Package / Library Purpose
Fiber Web framework for Go
PGX PostgreSQL driver for Go
Swagger API documentation
JWT JSON Web Token authentication
Crypto Secure hashing and encryption
godotenv Environment variable management

πŸš€ Getting Started

  1. Install Go on your machine.
  2. Get your PostgreSQL database set up.
  3. Get an IDE or text editor of your choice.

βš™οΈ Setup

  1. Clone the GitHub repository:
    git clone https://github.com/Jenil-Desai/Pixelbloom-backend.git
  2. Navigate to the project directory:
    cd Pixelbloom-backend
  3. Install dependencies:
    go mod tidy
  4. Create a .env file in the root directory and set up your environment variables:
    DATABASE_URL=""
    JWT_SECRET=""
  5. Run the application:
    air -c .air.linux.conf

🎯 Features

βœ”οΈ User Details Endpoints – Manage user profiles and authentication
βœ”οΈ Wallpapers Endpoints – Upload, update, and retrieve wallpapers
βœ”οΈ Liked Wallpapers Endpoints – Track user interactions with wallpapers
βœ”οΈ Bookmarked Wallpapers Endpoints – Allow users to save their favorite wallpapers


πŸ”— Demo & Screenshots

  • You can test the API using Hoppscotch or any other API testing tool.

πŸ™ Acknowledgments

  1. Fiber Docs
  2. Medium Blog on JWT

πŸ“œ License

This project is licensed under the MIT License. See the LICENSE file for details.


🎨 Enhancing the Pixelbloom experience with a powerful backend!

About

Backend for Pixelbloom mobile app using Go, Fiber, and PostgreSQL. πŸš€πŸ“±

Topics

Resources

Stars

Watchers

Forks

Languages