GithubHelp home page GithubHelp logo

jordan883 / storyboard Goto Github PK

View Code? Open in Web Editor NEW
3.0 2.0 0.0 1.16 MB

A story-writing app where kids can share their writing and parents can moderate content. Project for CS-555.

JavaScript 47.43% CSS 7.30% HTML 36.06% Handlebars 9.21%

storyboard's Introduction

Storyboard

.github/workflows/node.js.yml

A story-writing app where kids can share their writing and parents can moderate content. Project for CS-555.

Installation/How To Run

Dependencies

Before downloading this program, you'll need to install the following items to your computer:

Downloading/Running the Program

Download

  1. git clone this repo to your computer.
  2. On the command line, go to the repo folder and run npm i.

Run

  1. If MongoDB is not running, turn it on.(MongoDB must be running on your machine before you can use the website. If you installed MongoDB as a service, it will always run in the background, but otherwise, you need to run it manually.)
  2. Run npm start to start the web server on your computer.
  3. Follow the output instructions to see the website.

Tips/Debugs

  • Under config/settings.json, you may need to change the serverURL to localhost (instead of 127.0.0.1). Generally, 127.0.0.1 works for Windows; localhost works for other OS.

Developer Tips

  • Earlier, we used a system of devtips.md markdown files to hel document this program and some code tips. We've now moved these files to the storyboard GitHub wiki!
  • We're all here to learn and have fun doing it. If you have any questions, feel free to ping me on Slack. Good luck and happy programming! - Jordan :)

storyboard's People

Contributors

jordan883 avatar wjzhou14 avatar chchun0322 avatar

Stargazers

Boralus avatar  avatar  avatar

Watchers

Siyan avatar  avatar

storyboard's Issues

Register kid/adult pair

As a user,

I want to register

so that I can use an account to post stories, or rate content, on the website.

Post video

As a user,

I want to post a video

so that others can see and enjoy my video content.

View article

As a user,

I want to view an article

so that I can read and enjoy it.

Comment on article

As a user,

I want to comment on an article

so that I can let the writer know what I thought of their article.

Block user

As a user,

I want to block a specific user

so that I can no longer see their content or comments.

Score article

As a user,

I want to score an article

so that I can let the author know if I liked or disliked their writing.

Suspend child user

As a parent user,

I want to be able to suspend my child's account

so that they cannot use the site while they are suspended.

Post image

As a user,

I want to post a picture

so that others can see my artwork.

Edit article

As a user,

I want to edit my article

so that I can fix any mistakes I make, add things I like, or remove things I wrote that I no longer want.

See login history

As a user,

I want to see when I have logged into the site

so that I can be sure that my logins are authentic.

Content-rate article (parent)

As a parent user,

I want to rate articles based on inappropriate content

so that myself and other parents can know if this article contains inappropriate content.

Log in

As a user,

I want to log in

so that I can access my account.

Block user for child

As a parent user,

I want to block a specific user from my child

so that they can no longer see their content or comments.

Log out

As a user,

I want to log out

so that I can leave the website, and other people can't use my account while I'm gone.

Register family from parent

As a parent user,

I want to register other parents and my children with me in a single process

so that it's easier for my family to register together

Delete article

As a user,

I want to delete an article

so that other users can no longer see it.

View child view/post history

As a parent user,

I want to view my child's viewing and post history

so that I know what content they're seeing and who they're interacting with.

Restrict child viewing privileges

As a parent user,

I want to restrict what articles my child can see

so that they aren't exposed to inappropriate content that I don't want them to see.

Two-factor authentication

As a user,

I want to see when I have logged into the site

so that I can be sure that my logins are authentic.

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.