Política Aberta

Chat with Portguese political parties.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

This is the frontend of Política Aberta, an open source project to help the Portuguese electors to choose their vote. It acts like a chatbot, where users can ask things to political parties and the answer is based on their political program.

Feel free to clone this repo, run it locally and contribute!

Prerequisites

The following prerequisites are needed to run the project:

• Node

  # Linux
  apt install node
  
  #OSX
  brew install node

• npm

  # Linux
  apt install npm
  
  #OSX
  brew install npm

• [Optional] Docker

  # Linux
  apt install docker
  
  #OSX
  brew install docker

Installation

1. Clone the repo

   git clone https://github.com/politica-aberta/frontend.git && cd frontend

2. Install Python packages

   npm i

3. Edit .env.local file with your own data

(back to top)

Usage

Run locally

To run the project locally, simply run it with flask cli:

npm run dev

Run with docker

You can also run it with docker

docker compose up --build

(back to top)

Roadmap

• Add prompt examples
• Enhance signup email
• Apple sign up
• install bun in docker for faster deployments
• stream backend responses

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions are greatly appreciated :)

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the corresponding tag.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Hugo Pitorro - xtwigs - pitorro@politica-aberta.pt

José Martinho - jmartinhoj - martinho@politica-aberta.pt

Project Link: https://github.com/politica-aberta/frontend

(back to top)

Acknowledgments

(back to top)