laurabeatris / active-businesses-locations Goto Github PK

Describe the feature request

Add the component to show the oldest business

Describe the solution you'd like

The component should show the oldest business and also fetch it

Tasks

• Add hook to fetch oldest business
• Add component

Describe the feature request

Set up the architecture and initial structure of the API.

The architecture is going to be based on DDD and the development process is going to be based on TDD.

Describe the solution you'd like

As DDD is going to be applied, the domain layers should be configured, refer to the following structure:

• domain
  • infra
  • interfaces
  • services
    • tests
    • service
  • dtos

Must follow the principles of SOLID and configure a container for dependencies.

Tasks

• Set up structure with Express as the Web Framework.
• Configure code styles tools such as Editor Config and Eslint.
• Configure husky and lint-staged to run scripts based on git hooks.
• Add base folders with .gitkeep to be used on the next pull requests.
• Configure TypeORM and use Mongo as the database.
• Add README.md with base instructions to run the API.
• Configure dependencies container

Describe the feature request

Add the businesses domain in order to retrieve data about the businesses.

Describe the solution you'd like

The frontend should receive the locations data according to these three filters:

A new service should be created for each filter since the logic to parse the data is different.

• GetOldestBusinessService
• GetBusinessWithMostLocations

The controllers can be the following:

• BusinessesController
  • show method receives two types of query params (oldest and most-locations)
  • index method returns all the locations fetched from the data source.

Tasks

• Create GetOldestBusinessService and add tests
• Create GetBusinessWithMostLocations and add tests
• Create GetAllBusinessesService and add tests
• Create BusinessesController
• Create BusinessWithMostLocationsController
• Create OldestBusinessController
• Create businesses routes

Notes

Return only the first page of businesses

Describe the feature request

Add the component to list businesses

Describe the solution you'd like

Fetch and show the list of business

Usage:

<BusinessesList />

Tasks

• Add component
• Add hook to fetch businesses
• Show component on the main page

Describe the feature request

Filters for the businesses list

Describe the solution you'd like

A component that has three types of filter:

• To show all the business -> BusinessFilters.All
• To show the oldest business -> BusinessFilters.Oldest
• To show the business with the most locations -> BusinessFilters.MostLocations

Usage:

<BusinessFilters onFilterChange={handleFilterChange} />

Tasks

• Add component
• Show on the main page

Describe the feature request

Add the main page to show the header, business filter, and businesses list

Describe the solution you'd like

The page should show the businesses according to the filter currently selected

Tasks

• Add page
• Show header
• Show business filter
• Show businesses according to the selected filter (All, oldest, and with most locations)

Describe the feature request

Add the component to show the business with the most locations

Describe the solution you'd like

The component should show the business with the most locations and fetch it

Tasks

• Add hook to fetch the business with the most locations
• Add component

Describe the feature request

A header component to show an introduction message

Describe the solution you'd like

A header component with text constants and also extensible via props

Usage:

<Header title="Welcome!" message="Explore the LA businesses" />

Possible implementation:

const Header = ({ title = headerTexts.title, message = headerTexts.message }) => (...);

Tasks

• Add component
• Show on the main page

Describe the feature request

Add the user domain in order to retrieve and create the user data

Describe the solution you'd like

The frontend will upload the user avatar and send the username to the backend and we must store this data in order to retrieve on the next accesses.

The following repositories should be created:

• UserRepository (Should also create a fake class in order to use for unit tests)

The following service should be created:

• CreateUserService

The following providers should be created in order to upload photos:

• StorageProvider

The following controller should be created in order to retrieve the user data:

• UserController

Tasks

• Create StorageProvider - For now, it can use the file system.
• Create User schema
• Create UserRepository and FakeUserRepository
• Create CreateUserService and tests
• Create UserController

Describe the feature request

Set up the architecture and initial structure of the frontend.

Describe the solution you'd like

Use Next.js to easily set up a page and fetch data from the API. In order to avoid writing the styles manually with CSS, using a components library like Chakra-UI

Tasks

• Initialize app with Next.js and TypeScript
• Configure code styles tools such as Editor Config and Eslint.
• Configure husky and lint-staged to run scripts based on git hooks.
• Configure Chakra-UI

Describe the feature request

Add the business component

Describe the solution you'd like

Show the business data

Handle the case when the component shows a badge

Usage:

<Business
  badgeText="Some badge text"
  locationsCount={5}
  city="Some city"
  street="Some street"
  zipCode="Some zipcode"
  name="The business name"
/>

Tasks

• Add component
• Show on the main page