Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/evilpegasus/yearbook

A virtual personal yearbook for 2020 graduates to sign
https://github.com/evilpegasus/yearbook

css education firebase html javascript school yearbook

Last synced: 5 days ago
JSON representation

A virtual personal yearbook for 2020 graduates to sign

Awesome Lists containing this project

README

        

[![forthebadge](https://forthebadge.com/images/badges/made-with-javascript.svg)](https://forthebadge.com) [![forthebadge](https://forthebadge.com/images/badges/uses-html.svg)](https://forthebadge.com)
# Yearbook 2020
A personal virtual yearbook for students and class of 2020 graduates to sign.

Try it here:

https://yearbook-hhs.web.app/

![Demo Image](https://github.com/evilpegasus/Yearbook/blob/master/demo.PNG)

# Usage

## Signing in
You can sign in with either a Google account or a Facebook account. You can access a demo Yearbook without signing in and you can also access others' Yearbooks without signing in, but some features will be disabled.

## How to use Yearbook
To draw, select a color or the eraser and click and drag on the white canvas. Lines will be drawn while the left mouse button is held down. The thickness and color of the line can be changed using the **Toolbar** menu at the bottom of the screen. The **Clear Changes** button will clear all changes you have made to the canvas.

When you have finished drawing, click the **Upload** button to save your changes to our servers. The **Update Page** button will update the canvas to reflect any changes to the canvas that may have happened since the last update. This will not overwrite your changes.

## Sharing Yearbooks
You can share your Yearbook page by opening the menu in the top left and selecting **Share your Yearbook**. This will copy a custom link to your page to your clipboard. You can then share this link with other people. **Anyone with your link can write on your page.** Only share your link with people you trust. You can access your friends' Yearbooks through the custom links they send you. You must be signed in to share your Yearbook.

## Saving your Yearbook
To download your yearbook page, open the **Toolbar** at the bottom of your page and select **Download**. A link to a picture of your page will be emailed to the email you signed in with. You can then save the picture locally. You must be signed in to save your Yearbook.

## Supported Devices
Any computer running a modern web browser will be able to access Yearbook. Touchscreen devices are recommended, as drawing with a mouse/trackpad may be difficult. Touchscreen devices will only be able to touch scroll if touched outside the canvas.

## Contributing
This project is open for new features, improvements, or bug fixes. If you want to contribute, please send us a [pull request](https://github.com/evilpegasus/Yearbook/compare). If you want to request a new feature or improvement, please open a new [issue](https://github.com/evilpegasus/Yearbook/issues/new) and describe your feature/improvement request.

## Report a Bug
If you find a bug, please open a new [issue](https://github.com/evilpegasus/Yearbook/issues/new). Please include steps to reproduce the bug and any other helpful debugging information.

## Contact
The Yearbook 2020 team can be reached at [email protected].