Skip to content
Community Resources is a full stack application that uses Community Resource Information from Data.Nashville.gov.
PHP HTML
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
community-api
data
.gitignore
readme.md

readme.md

Community Resources

Community Resources is a full stack application that uses Community Resource Information from Data.Nashville.gov.

When someone is hurting and needs help, your struggle shouldn't be against technology. What would happen if the data was cleaned up so that it could be presented in a gentle and shareable way?

Less struggle with technology gives you more time to be present, listen, and lend a hand. ❤️

Goals:

Updates are being added to my '100 Days of Code' post.

Quick glance:

  • Create database & import data from CSV format
  • Cleanup data (In progress)
  • Create API endpoints
  • Wireframe front end
  • Create front end
  • Build out views

Tech/framework used

Currently built with:

Installation

// TODO: Verify instructions work with a fresh install. Add additional info about versions.

Backend

Requirements

File Setup

  • Clone the project down and open using your favorite editor (VSCode is great)
  • In community-api, make a copy of .env.example and rename to .env.

After you've created your database, return to this section:

  • Browse to the database section (where variables begin with DB_)
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=YOUR-DATABASE-NAME
DB_USERNAME=YOUR-USERNAME
DB_PASSWORD=YOUR-PASSWORD

MAMP Setup

  • After installing MAMP, open the program. (While Pro is wonderful, you can use the free version just fine for this project)
  • Select MAMP > Preferences from the toolbar
  • Select the 'Ports' tab
    • Apache Port: 80
    • Nginx Port: 81
    • MySQL Port: 3306
  • Select the 'Web Server' tab
    • Change the document root to YOURPATH/community-resource-center/community-api/public
  • Start the server: 'Start Servers'
  • then 'Open WebStart page'

Create the Database

  • From the WebStart page, scroll down to 'phpMyAdmin'
  • Open 'phpMyAdmin'
  • Select 'Databases' from the top tab bar
  • Under create database, give your database a name. Example: community-api
  • and click the 'Create' button
  • Add your new values to your .env file. See instructions in File Setup above.

API Installations

  • Inside the community_api folder, run:
    • composer install to install the back-end packages
    • php artisan passport:install for oauth public key

Migrations & Seeding A copy of the open data is included in the repo. To get the data into your database, run:

  • php artisan migrate
  • php artisan db:seed

License

MIT © Abby Fleming

You can’t perform that action at this time.