Imagine - Tell Me A Story (IN PROGRESS)

📗 Table of Contents

• 📖 About the Project
  • 🛠 Built With
    • Tech Stack
    • Key Features
    • Preview
  • 🚀 Live Demo
• 💻 Getting Started
  • Setup
  • Prerequisites
  • Install
  • Usage
  • Database
  • Deployment
• 👥 Authors
• 🤝 Contributing
• ⭐️ Show your support
• 🙏 Acknowledgements

📖 [Imagine - Tell Me A Story]

Imagine - Tell Me A Story is a web application for designed for users with a love for reading and/or writing. A user is able to create an account that is stored on the DB. The user can also select a number of interests upon logging in to the app. They can read stories that are already published on the app and also share their own stories if they're so inclined. A user is allowed to customize their profile as well as view other users' profiles, interests and stories. These are just but few of the features included in this app. There are also comments, replies and so much more to come...

🛠 Built With

Tech Stack

Client

• React.js

Server

• MERN Stack

Tools

• REST API

Deployment

• Vercel

Key Features

• [Creates an account for users]
• [Allows users to select their topics of interest]
• [Allows users to read stories written by other users]
• [Allows users to share their own stories publicly (including anonymously)]
• [Allows users to comment on shared stories]
• [Allows users to reply to comments]

Preview

(back to top)

🚀 Live Demo

• Live Demo Link

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

- git
- node

Setup

Clone the frontend repository to your desired folder:

$ git clone https://github.com/trace-kadenyi/storybrooke-frontend.git

Clone the backend repository to your desired folder:

$ git clone https://github.com/trace-kadenyi/storybrooke-backend.git

Install

ON two separate terminals, install this project with:

1st Terminal:

  cd storybrooke-frontend
  npm install

2nd Terminal:

  cd storybrooke-backend
  npm install

Usage

To run the project locally, execute the following command:

  npm run start

Database

You will need to create your own db on MongoDB for this project. Follow THIS LINK for directions on how to do so.

Deployment

You can deploy the project to Vercel by following these steps:

• Create a new site on Vercel
• Select your repository
• Select the branch to deploy
• Vercel automatically configures the correct settings for your project
• Click on deploy

(back to top)

Authors

👤 Tracey Kadenyi

• GitHub: @trace-kadenyi
• LinkedIn: @Tracey Kadenyi
• Twitter: @traci_K7

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

Give a ⭐️ if you like this project!

(back to top)

🙏 Acknowledgments

• I started this project to learn Node.js in particular. This tutorial by Dave Gray was fundamental in helping me get started with this project.

(back to top)

📝 FAQ

• How can I report a bug?
  You can report bugs by opening an issue.

• How can I request a feature?
  You can request a feature by opening an issue.

(back to top)