WeStory

A collaborative story writting app, where users can author a story with collaberation from users.

Report Bug · Request Feature

About The Project

---

Built With

Express : Sass : jQuery : EJS

---

Getting Started

Prerequisites

• npm
• node

Installation

1. Clone the repo

   git clone https://github.com/TeaBizzy/WeStory.git

2. Install NPM packages

   npm install

3. Reset database

   npm run db:reset

Accessing the Website

1. Start the server

   npm run local

2. Open your browser, and enter the following url

   http://localhost:8080/
   

3. Login by visiting the following URL. You can login with numbers 1-3

   http://localhost:8080/login/1
   

---

Usage

Start A New Story

• Click the Create button to display the text box.

  

• Compose a story of 1-160 characters long, and click the orange checkmark to submit!

  

• If a story is invalid an error will appear.

  

---

Write / Accept Contributions

• Contributions have the same limitations as a new story, and the creation form is very similar.

  

• As the author of the story, you will see accept buttons on contributions. Clicking this will add the contribution to the story.

  

---

Finishing A Story

• Authors can 'lock' a story they own at any time by clicking the 'Finish' button on their story.

  

• Completing a story will remove all pending contributions, and prevent contributions from being created. The story will be marked as completed for other users to see.

  

---

Contact

Kelvin Huang - https://github.com/kelvinhuang98
Ruoning Jin - https://github.com/RuoningJin
Stefan Talbot - https://github.com/TeaBizzy

Project Link: https://github.com/TeaBizzy/WeStory

---

Acknowledgments

• Light House Labs