byhbt / kwtool Goto Github PK

Use Github action to build the Elixir code.

Acceptance criteria

• When push code to the branch develop, Github action should be triggered.

As a visitor, I can create a new account.

Acceptance criteria

• Create migration for user
• Redirected to the Dashboard after the registration is finished successfully.
• Encrypt user password before storing in database

Required fields:

• Email: unique
• Full name
• Company
• Password
• Confirm Password

Company is an optional field.

As a user, I can see the search result of a specific keyword.

Acceptance criteria

Return the search result of a keyword.

• As a user, I can query all the stored search result data. For example:

Search "cheap flights" keyword which has a URL containing emirates word and has min_ads > 5.

Acceptance criteria

• Search based on the crawl result.

Feature request

• Upgrade Webpack 5.0 (https://webpack.js.org/blog/2020-10-10-webpack-5-release)
• Add autoprefixer module

Implement a background job for crawling a specific keyword:

Acceptance criteria

• Integrate Oban for handling background job.
• Implement migration for keywords result.
• Store HTML code of the page/cache of the page into the keyword_results table.

As a user, I can see the list of uploaded keywords.

Acceptance criteria

The API should return a keyword list of a logged-in user

Acceptance

When the user submits the login form, which is created in the Frontend ticket:
Case 1: If the login information is valid 🟢

• Redirect to home page
• Display The name of the user on the top right of NavBar
• Display welcome message

Case 2: If the login information is NOT valid 🔴

• Stay at the login page with an error message

Handling authentication error when

• The session is expired.
• Non-logged visitor try to access some required authentication routes.

Acceptance criteria

• Redirect the user to error page.
• Add test for the not authenticated cases.

Allow users to query all the stored data across all their uploaded keywords.

Examples of the SQL queries which users can run:

• How many URLs contain the word “technology” in AdWords.
• How many times a specific URL shows up in stored search results.
• How many keywords have URLs in stored search results with 2 or more “/” or 1 or more “>”.

Acceptance criteria

• Display an input for the user to enter the keyword.
• Display search button
• When the user enters directly on the input, it should be able to search the same behavior with a click button.

As a visitor, I can see registration form when I access /sign_up.

Acceptance criteria

Display a form with these required fields:

• Email: unique
• Full Name
• Company
• Password
• Confirm password

When the user access /upload:

• Display an upload file form.
• Display Upload Button.
• Display a sample CSV content.
• Display a sample CSV link.

Acceptance criteria

• Display all the elements above.

Query all the keywords from the uploaded CSV file.

Acceptance criteria

• Handling user background job
• Save the result to database

(updating)

Acceptance criteria

(updating)

As a visitor, I can log in to my account when I access /sign_in

Acceptance criteria

1. Access /sign_in, display a form with these required fields:

• Login title
• Email
• Password
• Login button

2. Use HTML validation on the form

Setup Heroku deployment.

Reference:

• https://hexdocs.pm/phoenix/heroku.html

Acceptance criteria

• After the source code is merged into develop branch, it is deployed to the Heroku.

Create a base code structure using the Phoenix web framework.

Acceptance criteria

• Generate source code using mix phx.new kwtool
• Update README content to follow the project requirement.
• The website should be able to run locally.

Feature request

https://github.com/slime-lang/slime

Why

When users access /upload, they can upload a CSV file. After the upload form submitted:

• Keywords in the file must be parsed and stored in the table keywords.
• Validate extension .csv only.
• Validate empty keywords file.

Acceptance criteria

• Create keywords table migration.
• Keywords in the file must be parsed and stored in the table keywords.

Validation

• Validate file extension .csv only.
• Validate empty keywords file.

The overall header displayed on the top of every page.

Acceptance criteria

Navigation elements:

• Logo: clickable to the homepage
• Login: mockup link
• Register: mockup link

Load the list of uploaded keywords by the logged-in user

Acceptance criteria

• Only display the keywords which are associated with the user.
• User A cannot view the keyword details of user B.

Implement a background job for querying specific keywords.

Acceptance criteria

• Parse the HTML result and get the following data on the Google first result page:

1. Number of AdWords advertisers in the top position.
2. The total number of AdWords advertisers on the page.
3. URLs of the AdWords advertisers in the top position.
4. Number of the non-AdWords results on the page.
5. URLs of the non-AdWords results on the page.
6. Total number of links (all of them) on the page

User can submit the upload form

Acceptance criteria

• Validate file extension
• Warning when the upload is invalid

Integrate Bootstrap Framework to Webpack

Acceptance criteria

• The app can use Bootstrap css

(updating)

Acceptance criteria

(updating)

As a user, I can see the dashboard after successfully logged in.

Acceptance criteria

• Display empty layout
• Add navigation bar on the right

Load the list of uploaded keywords to the UI

Acceptance criteria

• List the keywords just uploaded to the Dashboard.
• Add Keyword navigation item to the header navigation.
• Add Keyword navigation item to the sidebar navigation.