Skip to content
This repository has been archived by the owner on Nov 3, 2020. It is now read-only.

Latest commit

 

History

History
72 lines (51 loc) · 2.73 KB

README.md

File metadata and controls

72 lines (51 loc) · 2.73 KB

Kauzy

A web app to list public figures and cases connected with them.

Help NeededKey FeaturesTechnology StackGetting StartedLicense

screenshot

The parliament elections are held in my home country, Slovakia, every four years and there is a lot of bad stuff that politicians and other public figures have done. It was that much that I have easily lost track of it. Hence, I have decided to create this tool that would help people like me search for public figures, and see what cases they might be connected to so that I can make informed decisions.

My vision for this project is very simple - create an environment for someone (either organization, co-author, activist) that would fill up the app with data. I have no intentions of writing very own content, instead, I would love the app to link from cases screen to various media from the country.

Goals:

  1. Create an app that every country could use to increase the awareness of its citizens.
  2. Keep this solution apolitical.

Help Needed

Since I have to take care of the project as whole, I would truly appreciate help with coding. A good place to start is to check out the list of issues.

Additionally, make sure you join our community Facebook Group (preferred language is Slovak for now).

Key Features

  • Manage the list of public figures (e.g. politicians).
  • Manage the list of cases. Assign public figures to the cases.
  • Attach internet links to the cases so that people can read more.

Technology Stack

  • Ruby
  • Ruby on Rails
  • PostgreSQL
  • Tailwindcss
  • Webpacker
  • RSpec

Getting started

The app is a standard Ruby on Rails application using PostgreSQL as database. The commands you will probably find the most useful are:

MacOS

  1. Clone the repository: git clone https://github.com/marekdlugos/kauzy.git
  2. Install PostgreSQL: brew install postgresql
  3. Start PostgreSQL: brew services start postgresql
  4. Create the database: rails db:create
  5. Create the tables: rails db:migrate
  6. Seed the database with basic data: rails db:seed
  7. Start the server: rails s

License

MIT


marekdlugos.com  ·  GitHub @marekdlugos  ·  Twitter @MarekDlugos