You are on page 1of 5

Summary

Goal 2

Summary 2

Database 2

Technology 2

Functionalities 3

Code specifics 4

Delivery 4

Privacy 5

Pay attention to the following: 5

How to start? 5
1. Goal

Create a code that constantly monitors Amazon product listing indexing


information

2. Summary

We need to create a code that will monitor Amazon US listings indexing


information and save the info as .json files. The code should run indefinitely within a
range defined by configuration.

3. Database

There's no database on this code.

4. Technology

a. Backend

i. NodeJS LTS version 16+


ii. Requests/Fetch/Axios library
1. Browser automation (e.g., Puppeteer) cannot be used

b. Frontend
i. Not needed, everything will be on Google sheets
c. Web Server
i. Not needed

d. Database
i. Not needed

5. Functionalities
Pay attention to those as we’re going to test them before marking the job as
successfully completed.

a. Config
i. All the config must be presented in a .env file

1. asin

2. keywords_to_check

b. Core
i. Must change the zip code on Amazon to 11001 before starting to
get information. This may help you. https://cln.sh/NijFhs
https://cln.sh/D7jKVp
ii. Check if the ASIN is indexed on all keywords presented on the .env
file
1. Search for “ASIN Keyword” (example: B08H75RTZ8 Xbox)
2. Results came as “1 result for … “? = indexed
3. Results came as any other information like empty, null, more
than one results = not indexed.
iii. Save results as Yes (indexed) and No (not indexed) for each
respective keyword in the .json file. You should always overwrite
the information already there.
c. Logger
i. Must log every vital action of the script
ii. Must log errors that break the code
iii. Must save the log on file
iv. Must print the log on terminal

6. Code specifics
a. You must test the code before delivering.
b. The code must be able to run for a long time without human intervention
c. You must follow Semantic Versioning in the code (https://semver.org)
d. You must document (use comments inside the code) the essential
methods to keep the code readable to others
e. You must lint your code using the appropriate linting for the chosen
language

7. Delivery
a. WHAT WE provide

i. Sheet example access

b. WHAT YOU should deliver

i. The final code that


1. Followed all the guidelines and requirements in this
document
2. Contains all functionalities presented in this document
3. It was thoroughly tested
4. It was developed following the best development practices
such as reusability.
ii. Comments on the most essentials methods/functions
iii. Readme.MD with a brief tutorial teaching how to perform the
installation/use

c. WHERE should you deliver

i. You should push the source code to a private GitHub repository


created by us. We would need your email to add you to it.
ii. IMPORTANT: You can't publish it into your git account as public or
private.

8. Privacy

a. Pay attention to the following:

i. The repo license to be used is GPL.


ii. The servers credentials we will provide cannot be shared
iii. The code cannot be shared
iv. The code cannot be used as a portfolio in your git account
v. The code cannot be reused with other clients.

You automatically agree to our privacy terms if you accept the offer we sent
you.

Breaking our agreement after accepting our offer would involve civil legal
action taken by us, resulting in the termination of your UpWork account.

9. How to start?
a. If you are ok with these guidelines, please apply for the job.

You might also like