Giter VIP home page Giter VIP logo

docs's Introduction

Hey there! I'm Mathias Pepin-Leduc, I am 20 y.o and aspired to become a Java, Rust and TypeScript programmer.

I use Arch btw

My projects

  • Exvoid Network, a Canadian-french multiplayer games hosting community that I own and operate.
  • Feedbacky, a free software for collecting feedback in which I am moderating and documenting.

docs's People

Contributors

gitbook-bot avatar matou0014 avatar plajer avatar

Watchers

 avatar

docs's Issues

Graveyard

Texts that I have written that I no longer use but that could be useful to me in the future.

  1. Meta tags.

Have a description of your board shown when sharing your board.

File to edit; https://github.com/feedbacky-project/app/blob/master/client/public/index.html

Structure tree

app
├─ .git
│   └── ...
├── .github
│   └── ...
├── client
│   ├── nginx
│   │   └── ...
│   ├── public
│   │   ├─ favicon.icio
│   │   ├─ index.html
│   │   ├─ logo192.png
│   │   ├─ logo512.png
│   │   ├─ manifest.json
│   │   └─ robots.txt
│   └── src
│       └─ ...
└─── server
     └── ...
  1. Mail templates

Change the looks of Feedbacky's mails.

File to edit; https://github.com/feedbacky-project/app/tree/master/server/src/main/resources/mail_templates

Customize email templates Head over [to this folder](https://github.com/feedbacky-project/app/tree/master/server/src/main/resources/mail_templates) and edit HTML of files as you wish.
Be careful not to replace any placeholders like ${host.address}
The mail template directory is situated in app/server/src/main/ressources/mail_templates.

Structure tree

app
├── .git
│   └── ...
├── .github
│   └── ...
├── client
│   ├── nginx
│   │   └── ...
│   ├── public
│   │   └── ...
│   └── src
│       └─ ...
└─── server
     ├── gradle/wrapper
     │   └── ...
     └── src/main
         └── ressources
             └── mail_templates 

To Do

A list containing things I plan on adding/changing or removing from the Feedbacky official documentation.

Projects Overview

Introduction

README
  • Implemented

Introduction should follow feedbacky-project/app README page, need to open a PR and syncing both.
https://github.com/Matou0014/app/tree/readme-update

Features

FAQ

Why did you make Feedbacky?
  • Implemented
Announced on December 9th, 2019 and originally named User Voice BETA was the consequence of multiple failed attempts to find a good feedback collecting service for my own Minecraft projects. 

It was originally created in pure PHP and due to earlier versions being buggy and a mess, I chose to entirely redo it from scratch with the goals of making it useful for everybody in mind.

I renamed the project to Your Voice, since the former being an already existing company and this time I chose Java as a candidate because it is my best known language. I went with Spring MVC for the backend framework and JSP + Tomcat for the frontend framework.

Ultimately, I rebranded to Feedbacky, which is a much more catchy name and moved to react for the frontend. 
Feedbacky will always be there to help you collect feedback and issues from your customers.

(Hint) You can look at an archived version of User Voice before it was in early beta stage as a project called Plajer's Lair User Voice here.
https://uservoice.plajer.xyz/
Why does Feedbacky loop when I start it? (Self-hosting)
  • Implemented
Is the Feedbacky cloud instance free?
  • Implemented

Case Studies

Credits

Donating

Links

Links

Getting Started

Installation

Domain Setup

Caddy
  • Implemented

Updating/Upgrading

Handbook

Quick Start

Quick Start
  • Implemented

To see https://app.feedbacky.net/i/initial-installation-setup.2595

- Name and discriminator
- Branding
- Theme
- ~Conclusion

Must take screenshots of each sections.

Like the title of this step implies, you must give your board a name and a discriminator.
What's a discriminator?
The discriminator will be the URL to your board, it can contain alphanumeric characters like a-Z, 0-9 and -
Text with alphanumeric characters a-Z 0-9 and -
Example: Project is called My Awesome Project discriminator can be set to myawproj or similar.
Minimum 3 and maximum 20 characters.
Name of your board should be at least 4 and maximum 25 characters long.
Upload a banner and logo about your brand. 
Upload your board banner.
Maximum size 650 kb, png and jpg only.
Suggested size: 1120x400

Upload your board logo.
Maximum size 250 kb, png and jpg only.
Suggested size: 100x100

Features

How To

Upgrade in the background

Moderate your board

Add OAuth Providers

Reference

Upgrading to 0.5.0

Upgrading to 0.2.0

Older Releases

Developer

API Usage

Community Guide

Installation (Windows)

Installation (Windows)
Prerequisites
Docker Desktop (installation tutorial)
Docker Compose (installation tutorial)
MariaDB Database (installation tutorial)
Git Bash (download)
SMTP mail server or account at Mailgun or account at SendGrid
An account on at least one of the following services, Discord, GitHub, Google (for OAuth login since Feedbacky is passwordless)
200 MB free space for Feedbacky itself
(Optional) HeidiSQL, a GUI tool to edit and view MySQL tables. (download)

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.