Skip to content

PicScape serves as an archive for profile pictures, banners, and wallpapers. On PicScape, users can discover and share stunning and aesthetic artwork, enhancing their online presence or desktop aesthetics.

Notifications You must be signed in to change notification settings

PicScape/PicScape-Backend

Repository files navigation

PicScape-Backend

This is the repository for the backend of the open-source PicScape project. PicScape serves as an archive for profile pictures, banners, and wallpapers. On PicScape, users can discover and share stunning and aesthetic artwork, enhancing their online presence or desktop aesthetics.

Overview

Project Setup

Run in dev mode

npm run docker:dev

Run in production mode

npm run docker:prod

For the complete functionality of this project, the frontend is essential.

API Routes (extremely outdated and I will move it to a wiki soon)

authRoutes.js

POST /auth/login
The endpoint provides the JWT authentication key only if the email and password sent in the request body correctly correspond to a registered user.

POST /api/register
This endpoint receives a request with a password, email and username in the body, then  adds it to the "Account" collection.

fetchRoutes.js

GET /fetch/account
This endpoint responds with the account information corresponding to the token contained in the "Authorization" header.

POST /fetch/account/:username
This endpoint responds with the account information corresponding to the username specified in the parameter ":username".

Project Status

PicScape is a relatively new project and it may currently lack some functionality and features. However, I am continually improving the project in the future. Additionally, PicScape will be available as a fully functional service in the future, ready for you to use.

Reporting Issues

If you encounter any problems while using PicScape or have suggestions for improvement, please don't hesitate to open an issue on the GitHub repository. Your feedback is crucial in helping me identify areas for enhancement and address any issues that arise.

To report an issue:

  1. Go to the Issues section of the repository.
  2. Provide a clear and detailed description of the problem you've encountered or the feature you'd like to suggest.
  3. If possible, include steps to reproduce the issue or examples to clarify your suggestion.
  4. Add any relevant files.

Thank you for your help.

About

PicScape serves as an archive for profile pictures, banners, and wallpapers. On PicScape, users can discover and share stunning and aesthetic artwork, enhancing their online presence or desktop aesthetics.

Topics

Resources

Stars

Watchers

Forks