Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/suriyaa/storydrop

Suriyaa's Final Project for Harvard's CS50x 2018
https://github.com/suriyaa/storydrop

2018 cs50 cs50x dropzone edx edx-cs50 final-project harvard harvard-university harvardx php platform storydrop upload website youtube

Last synced: 15 days ago
JSON representation

Suriyaa's Final Project for Harvard's CS50x 2018

Awesome Lists containing this project

README

        

StoryDrop - CS50x Final Project





StoryDrop


Make book publishing more simplified and more democratised.

Built with HTML, CSS, JavaScript and PHP.



Build Status





Travis CI Build Status


CircleCI Build Status





Facts





GitHub code size in bytes


GitHub contributors


PRs Welcome


GitHub issues


GitHub pull requests


## Table of Contents

- [Introduction](#introduction)
- [Story Behind](#story-behind)
- [Features](#features)
- [Feedback](#feedback)
- [Dependencies](#dependencies)
- [Contributors](#contributors)
- [Development / Installation Process](#development--installation-process)
- [Contributors](#contributors)
- [Supporters, Backers and Sponsors (Acknowledgments)](#supporters-backers-and-sponsors-acknowledgments)
- [Copyright](#copyright)

## Introduction



This is CS50x

**This is StoryDrop.** A revolutionizing web platform for publishing books (with `.pdf` file type) online.

### Why do we need it?
Many manuscripts from authors, writers and creators are often rejected by publishers day by day:


The Peanuts - Send me 50 thousand dollars


Copyright © Charles M. Schulz / United Feature Syndicate, Inc. All rights reserved.

The StoryDrop platform allows everyone publishing their **OWN** story and (e-)books effortless and hurdles-free.

### How does it work?
The platform maintainer or the person/team/company who/that is responsible for running the platform review(s) newly uploaded books in the `uploads/new/` folder. After a fast and open verification process the books are going to be published online at `uploads/verified/`.

*No more publishing companies or dastardly editors that are greedy for money!*

### Vision
> **StoryDrop makes book publishing more simplified and more democratised.** *- [Suriyaa R. Sundararuban][suriyaa] (creator of StoryDrop)*

## Story behind
StoryDrop is the final project made by [Suriyaa R. Sundararuban][suriyaa] ([@SuriyaaKudoIsc][github]) - a student at the [Technische Universität München (TUM)][tum] - for [Harvard's][harvard] [CS50x 2018][cs50] course.

[![Twitter Follow](https://img.shields.io/twitter/follow/SuriyaaKudoIsc.svg?style=social&label=Follow)](twitter.com)

## Features
* Custom 404 error page at `http(s)://www.your-storydrop-domain.tld/errors/404.html`
* Landing page at `http(s)://www.your-storydrop-domain.tld/`
* Contact page at `http(s)://www.your-storydrop-domain.tld/contact.php`
* Upload page with HTML form for uploading `.pdf` files at `http(s)://www.your-storydrop-domain.tld/upload.php`
* Showcase site at `http(s)://www.your-storydrop-domain.tld/showcase.php`
* ASCII HTML Art Code in `includes/header.php`

## Feedback

Feel free to send me feedback on [Twitter](https://twitter.com/SuriyaaKudoIsc) or [file an issue](https://github.com/SuriyaaKudoIsc/storydrop/issues/new). Feature requests are always welcome. If you wish to contribute, please take a quick look at the [guidelines](./CONTRIBUTING.md)!

If there's anything you'd like to chat about, please send me an [e-mail][email]!

## Dependencies

* [Uniform Server][uniformserver] ([ZeroXIII][zeroxiii])
* [Dropzone.js][dropzone]
* [QuickGallery][qgallery] ([commit `8b70912`][qgallerycommit])
* [PHP Contact Form][firstwebdesigner]
* [all-contributors-cli][allcontrib] ([v5.4.0][allcontribsemver])

## Development / Installation Process

### For developers

* Download the latest [Uniform Server](uniformserver).
* Extract the installation file.
* Clone this project: `git clone https://github.com/SuriyaaKudoIsc/storydrop.git`
* Put this folder in the `www/` directory of the [Uniform Server](uniformserver).
* Run the `UniController.exe` file in the root directory (on Windows), start the Apache & MySQL servers.
* :tada: It works!
* :pencil: Start contributing...

### For production

* Download the latest [Uniform Server](uniformserver).
* Extract the installation file.
* [Download](https://github.com/SuriyaaKudoIsc/storydrop/archive/master.zip) this project.
* Put the `storydrop` folder in the `www/` directory of the [Uniform Server](uniformserver).
* Run the `UniController.exe` file in the root directory (on Windows) and start the Apache & MySQL servers.
* :smiley: Nice. Go to `http://localhost/`
* :tada: You run your own local StoryDrop platform!

### For repo maintainer(s)

Automate [adding contributor acknowledgements][allcontrib]:

npm run contributors:add -- SuriyaaKudoIsc doc
npm run contributors:generate

Add/update contributors (View the Emoji key spec [here][allcontribkey]):

# Add new contributor , who made a contribution of type
all-contributors add
# Example:
all-contributors add SuriyaaKudoIsc code,doc

Check for missing contributors:

all-contributors check

## Contributors

This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification and is brought to you by these [awesome contributors](./CONTRIBUTORS.md).

## Supporters, Backers and Sponsors (Acknowledgments)

Thanks for supporting me:

| [
edX.org](https://www.edx.org/)
(MOOC) | [
Technische Universität München](https://www.tum.de/) | [
Harvard University](https://www.harvard.edu/) | [
David J. Malan](https://cs.harvard.edu/malan/)
(Harvard's CS50 Professor) |
|:-:|:-:|:-:|:-:|
| [Financial Assistance][edxfinance] | For being a [TUM][tumcampus] student | Make [CS50][cs50] available worldwide | Explains very comprehensible |

## Copyright

Copyright 2018-present **[Suriyaa R. Sundararuban][suriyaa]** *(Graduate of [CS50x 2018][cs50])*

[suriyaa]: https://about.suriyaa.tk/
[tum]: https://tum.de/
[tumcampus]: https://campus.tum.de/
[cs50]: https://cs50.harvard.edu/
[harvard]: https://www.harvard.edu/
[edxfinance]: https://courses.edx.org/financial-assistance/
[dropzone]: https://www.dropzonejs.com/
[uniformserver]: https://www.uniformserver.com/
[zeroxiii]: https://sourceforge.net/projects/miniserver/files/Uniform%20Server%20ZeroXIII/13_3_2_ZeroXIII/
[allcontrib]: https://www.npmjs.com/package/all-contributors-cli
[allcontribsemver]: https://github.com/jfmengels/all-contributors-cli/releases/tag/v5.4.0
[allcontribkey]: https://github.com/kentcdodds/all-contributors#emoji-key
[qgallery]: https://github.com/mojeda/QuickGallery
[qgallerycommit]: https://github.com/mojeda/QuickGallery/tree/8b709128ec478b7536b4080fe977e806cf473757
[firstwebdesigner]: https://1stwebdesigner.com/php-contact-form-html/
[email]: mailto:[email protected]
[github]: https://github.com/SuriyaaKudoIsc