Giter VIP home page Giter VIP logo

picoshelter-apiserver's Introduction

PicoShelter-ApiServer

The server part on ASP.NET of the PicoShelter Project.

About PicoShelter Project

"PicoShelter is a free image hosting service with user profiles, shared albums, and direct links. Also, we provide the official desktop application for a more comfortable experience."

PicoShelter's ApiServer, WebApp, DesktopApp were created by heabijay as the diploma project.

Demo

This project demo currently serves on Azure App Service (Free Plan) since 05.05.2021.

Server endpoint: picoshelter-apiserver.azurewebsites.net

Swagger UI: picoshelter-apiserver.azurewebsites.net/apidocs

Due to the free plan on Azure, the server isn't alive all time so the first request could take some time.

Configuration

You need to rename two configuration files and fill your own configuration:

  1. PicoShelter-ApiServer/appsettings.Example.json => PicoShelter-ApiServer/appsettings.json

    This file presents the global server configuration.

    Main fields:

    • ConnectionStrings.DefaultConnection — The connection string to your database. Currently, we guarantee MySQL and MS SQL support.
    • WebApp.Default.HomeUrl — The URL path to the client part of the project. This is using in the email composing process, in redirect on the home route ./.
    • WebApp.Default.ConfirmEndpoint — Such as previous — the URL path, which is using in the email composing process to activate confirmation keys.
    • SmtpServers.DefaultServer.Host — SMTP host address. SMTP using for email sending.
    • SmtpServers.DefaultServer.Port — SMTP host port.
    • SmtpServers.DefaultServer.UseSsl — Is SMTP connection needs SSL.
    • SmtpServers.DefaultServer.Authorization.Username — SMTP username.
    • SmtpServers.DefaultServer.Authorization.Password — SMTP password.
    • SmtpServers.DefaultServer.FromAddress — Address, which sends emails. Could be the same as the SMTP username.
  2. PicoShelter-ApiServer/AuthOptions.Example.cs => PicoShelter-ApiServer/AuthOptions.cs

    This file presents the JWT composer settings.

    Main fields:

    • AuthOptions.Issuer — Issuer field of JWT.
    • AuthOptions.Audience — Audience field of JWT.
    • AuthOptions.Key — Master password for JWT hasher.
    • AuthOptions.Lifetime — The timespan for JWT valid until.

By default, File Repository with user's images uses the "FileRepository" folder of execution assembly path. You could change it in Startup.cs (~73 line with IFileUnitOfWork).

picoshelter-apiserver's People

Contributors

heabijay avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.