dereckluo / kiana Goto Github PK

User Story
As a user, I want to set request from browser to backend to perform various tasks.

Describe the solution you'd like
using express to build up a restful application which accept browser incoming requests.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Acceptance Criteria

• Have a working express backend.
• Able to send CRUD request from browser to backend.
• Able to send back correct status code.

User Story
As a developer, I want to have a clean README file to follow. Which include actions such as contribution guidelines, testing guidelines, etc...

Describe the solution you'd like
Write a clear README documentation, which has all basic information.
Following some README guidelines / templates is recommended.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Acceptance Criteria

• A clean README file for UI Service.
• A clean README file for Backend Service.
• A clean README file for Project Kiana.

User Story
As a developer, I want to develop UI service using React framework.

Describe the solution you'd like
Setup a basic React framework which is easy to be consumed.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Acceptance Criteria

• Setup React service, which include its own folder and node.
• Able to connect React service with backend service, and successfully send request and receive response.

User Story
As a user, I want to be able to use cURL commands to access reverse index functionality.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Acceptance Criteria

• export reverse index functionality via RESTful API route.
• correct accept frontend payload, and return correct results.

Description

Create a UI Service for project Kiana.

Initiative / goal

Create a workable front-end application for project Kiana.

Hypothesis

What is your hypothesis on the success of this Epic? Describe how success will be measured and what leading indicators the team will have to know if success has been hit.

Acceptance criteria and must have scope

• Setup Kiana UI service using React.
• Connecting to back-end service with GraphQL.

Stakeholders

Describe who needs to be kept up-to-date about this Epic, included in discussions, or updated along the way. Stakeholders can be both in Product/Engineering, as well as other teams like Customer Success who might want to keep customers updated on the Epic project.

Timeline

Sprint 1.
Sprint 2.
Sprint 3.

Description

Create a UI Service for project Kiana.

Initiative / goal

Create a workable front-end application for project Kiana.

Hypothesis

What is your hypothesis on the success of this Epic? Describe how success will be measured and what leading indicators the team will have to know if success has been hit.

Acceptance criteria and must have scope

• Create a nodeJS based backend service using express framework.
• Connect to Kiana UI service via GraphQL.
• Connect to MySQL database.
• Support initial business logic.

Stakeholders

Describe who needs to be kept up-to-date about this Epic, included in discussions, or updated along the way. Stakeholders can be both in Product/Engineering, as well as other teams like Customer Success who might want to keep customers updated on the Epic project.

Timeline

Sprint 1.
Sprint 2.
Sprint 3.

User Story
As a developer, I want to use Hadoop MapReduce to process data into database to create inverted index.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Acceptance Criteria

• Integrate Hadoop library in nodejs
• Implement Map function
• Implement Reduce function
• process data correctly and store them in database

User Story
As a user, I want to have a clean README document to follow while contributing to Kiana UI Service.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Acceptance Criteria

• A Clean README file for UI Service

User Story
As a user, I want to store information in a easy to access database.

Describe the solution you'd like
Set up a MySQL database service which connect to backend service, and able to accept rich query actions.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Acceptance Criteria

• Setup a workable MySQL database service.
• Able to perform rich query to database via backend service.

User Story
As a developer, I would like to have a development environment which is easy to contribute.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Acceptance Criteria

• Setup Github repo with Zenhub.
• Create first round of Epics.
• Setup nodeJS dev environment.
• Update project readme.

User Story
As a user, I want to have a set of data to perform reverse index from.
Which include but not limited to english literature, tv shows transcript, etc...

Describe the solution you'd like
A clear and concise description of what you want to happen.

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Acceptance Criteria

• Adding data into database.
• design optimal data schema.