Skip to content

JS00001/FBLAProjectV1

Repository files navigation

⭐ Athens Attractions

Need a place to eat? Or workout? This application has your back. Select from options such as location, price, distance, and more to view all of the mocked locations in your areaa.

FblaMockup-LIGHT

FblaMockup_DARK

🚀 Problem

You have been hired by your state or local area’s tourism bureau to develop a program that suggests attractions (can be tourist attractions, restaurants, shopping, things to do, etc.) to potential visitors. Your program will allow users to search for attractions in the area based on desired attributes, such as location, type of attraction, and amenities. Your program must include at least 50 attractions, and users must be able to define at least five desired attributes to search for an attraction.

🔨 Setup

Installation

  1. Download the latest release from https://github.com/JS00001/fbla-project-exe/releases
  2. Run the executable from the release files.
  3. Running the executable will install the program as Athens Attractions
  4. Upon first install, the program will automatically run.
  5. Use the program to find new attractions.

Building From the Source Code

  1. Download NodeJS and install the runtime.
  2. Download the source code of the repository.
  3. Move the files into a folder, and open a command prompt in the folder.
  4. Run npm install
  5. Once all dependencies are installed, run npm run build
  6. A folder named dist will be created it, inside of it will be the compiled program, Athens Attactions x.x.x install.exe

📜 Docs

File Structure

Folder Purpose Author
resources Assets for the Nextron build process Our Team
renderer NextJS Frontend Our Team
main Nextron Application Nextron (Unless Commented Otherwise)

ℹ️ Sources

Images

Item Website
Icons https://react-icons.github.io/react-icons/icons?name=ri
Empty State PNG's https://themeisle.com/illustrations
Location Images https://pixabay.com

Libraries

Libary Purpose
NextJS Frontend framework used for rendering the frontend
Nextron Fork of ElectronJS; Used for rendering the NextJS Frontend as an application (exe)
TailwindCSS Used for styling the frontend
React Icons Library containing all icons used
NextUI NextJS component library used for the UI
Redux Used for global state management (Stores the location data and selected filters
React-Redux Used to update components when the redux state is updated
Node-Fetch Used to make requests to PDF api
Electron-Store Used to store links to generated output reports

Features

  • Select filters to sort locations by.
  • Generate a cloud-stored PDF document containing all filtered locations.
  • View all reports that you have generated, and clear them.
  • Toggle the theme between light and dark.