PROJECT NUBIA

---

Nubia is an open-source project that aims to generate multiple stories from single cleaned data stream.

📝 Table of Contents

• About
• Getting Started
• Deployment
• Usage
• Built Using
• Contributing
• Authors
• Acknowledgments

🧐 About

Write about 1-2 paragraphs describing the purpose of your project.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

What things you need to install the software and how to install them.

• VScode
• NodeJs

Installing

A step by step series of examples that tell you how to get a development env running.

1. Install all packages

  // install all packages
  yarn

2. set up .env from .env.example

  // In the terminal
  // copy files in .env.example to a new file '.env'
  cp.env.example.env

3. Start dev server

  yarn run dev

4. To generate documentation from JsDoc

yarn run gen-docs

End with an example of getting some data out of the system or using it for a little demo.

🔧 Running the tests

There are currently no tests.

🎈 Usage

Available routes

• host.com/faac
• host.com/kerosine-watch

🚀 Deployment

Add additional notes about how to deploy this on a live system.

⛏️ Built Using

• MongoDB - Database
• Express - Server Framework
• VueJs - Web Framework
• NodeJs - Server Environment

✍️ Authors

• @oddFEELING - Technical fellow from Dataphyte

See also the list of contributors who participated in this project.

🎉 Acknowledgements

• Hat tip to anyone whose code was used
• Inspiration
• References