Skip to content

opengovsg/Filtable

Repository files navigation

Filtable

Filtable is a web app to convert your static CSV files/Google Sheets into beautiful list displays that are easy to view and filter both on mobile and desktop devices.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

To setup the project, ensure that you have Node (v16.15.0) installed on your system.

To check that you have Node installed, run

node -v // It will return the node version if you have Node installed

Set up your environment variables using the .env.example file

  • Google Sheets API
  • AWS S3

Installing

First, clone the repo

git clone https://github.com/raynerljm/Filtable.git

Then, change directory into the repo and install the dependencies

cd filtable
npm i

Run the development environment

npm run dev

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

  • This project was created under Open Government Product's Hack for Public Good 2023 together with Praveen, Natalie, Chien Ling, and Wenjia.
  • Thanks to Yuanruo and Jie Hao for being extremely important advisers throughout the project