codeforpdx/dwellingly-app

Application for property managers to communicate with social workers

Dwellingly App

Description

The nonprofit JOIN is working to help transition people out of homelessness. However, their current system for staying in touch with landlords is inadequate. Code for PDX is building the Dwellingly app in conjunction with JOIN. Dwellingly will aid property managers in communicating with social workers and will eventually aid in supporting both tenants and landlords with a more streamlined rental property process.

This app aims to replace the current system with a robust ticketing system to ensure the staff at JOIN can connect with their landlords and clients seamlessly. This will allow JOIN to provide support and improve success in transitioning people out of homelessness.

UI Preview

Dwellingly is being built from these FIGMA designs

The app is currently live at: https://dwellingly-app.herokuapp.com login: [email protected] password: asdfasdf

Contributing

• Please read and abide by our Code of Conduct
• Here is a guide to making contributions to this project on Github.

Prerequisite Technologies

• Rails dev environment: For info on how to install go to: https://gorails.com/setup/
  • Install with a postgres database, and its recommended to use Rbenv as the Ruby version manager.
  • For an easier setup: You can optionally skip postgres installation and use sqlite3. Instructions to use sqllite3 are below.
• Node (use node version ^14.17.0)
• yarn
• Git

Getting Started | Installing

Once necessary technologies are installed on your machine:

From Terminal:

• Navigate to your desired directory from the command line: example:cd Desktop/CodeForPDX/
• Clone Project - git clone https://github.com/codeforpdx/dwellingly-app.git
• Create your own working branch: example: git checkout -b add-new-component

Installing

From terminal:

• Navigate to your desired directory from the command line: example:cd Desktop/CodeForPDX/
• Clone Project - git clone https://github.com/codeforpdx/dwellingly-app.git
• Navigate to app's directory: cd dwellingly-app
• Copy the config file: run cp config/application.yml.example config/application.yml
• If using sqlite3 then uncomment sqlite3 in the config/application.yml file.
• run bin/setup
  • bin/setup will install dependencies, create the databases, and seed the database.
  • alternatively you can run each step manually with the following commands:
    • bundle
    • yarn
    • bin/rails db:create
    • rails db:schema:load
    • rails db:seed
• Start the servers
  • Start the Rails server with: bin/rails s
  • Start the weback server with: ./bin/webpack-dev-server
    • This will precompile javascript and reload the browser when there are javascript changes
  • Alternatively: You can use bin/dev to start both servers. (May not work with Windows)
    • This will use overmind if it is installed; otherwise it uses Foreman.
• View the app at localhost:3000
• See the testing section on how to run the tests.

About Us

• Code for PDX - Meetup Info
• Code for America
• JOIN Organization

Thank you for your help and happy coding!