Home About Me Projects Experience Skills More
FOCCACIA logo

FOCCACIA

FOCCACIA Team Management

Current Status
Completed
Links

GitHub
Main Tools
Editors
Other Tools

FOCCACIA / README.md



Logo

FOCCACIA

FOCCACIA Team Management


Report Bug · Request Feature


Table of Contents

  1. About
    • Built With
  2. Development
    • Prerequisites
    • Installation
  3. License
  4. Credits


About

FOCCACIA is a web application that helps you organize your favourite teams, leagues and seasons into groups. This project is the result of a team project for the PI course ("Programação na Internet") at ISEL.


Built With

  • Express.js
  • Handlebars
  • TailwindCSS
  • Passport.js
  • ElasticSearch


Development

In order to deploy a copy of FOCCACIA on your device to develop a feature or fix a bug, follow the steps below to get started.


Prerequisites

In order to run the application, you will need the following tools:

  • Node.JS (18.0.0 or higher)
  • npm
  • git (optional)

Installation

  1. Clone the repository
    git clone https://github.com/D3W10/FOCCACIA.git
  2. Download and setup ElasticSearch
  3. Run the ElasticSearch executable
  4. Go to Football API, create an account and get your API key
  5. Open the project folder using your prefered code editor (ex: VS Code)
  6. Go to src/data/fapi-teams-data.js and replace YOUR_API_KEY with your API key
  7. Install the npm packages
    npm i
  8. Run the application
    npm run start


License

Distributed under the MIT license. Check LICENSE for more details.



Credits

  • Made by D3W10