A tool bringing Registered Community Organization information to the forefront for community members
PHP HTML TypeScript CSS JavaScript Vue Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api
frontend
.editorconfig
.gitignore
.travis.yml
LICENSE
README.md
setup.sh

README.md

Registered Community Organization (RCO) Engagement

Improving Citizen Engagement with RCO's. 3.25.2017

![screenshot of landing page]

Description

A tool bringing Registered Community Organization (RCO) information to the forefront for community members by Code For Philly volunteers.


Setup/Installation Requirements

Setting up the front-end

The first step to setting up your enviorment is to install node.js. You can find the install download at the following url. https://nodejs.org/en/

Download and install the package. Once you have done this open up your console.

Next you will need to clone the github repo. You can find the repo at https://github.com/mcgrogan91/RCOEngagement. Once you have cloned this you will need to go back to your console and complete the following.

Install the npm packages described in the package.json and verify that it works: Run the below commands in your console.

npm install npm start

The npm start command first compiles the application, then simultaneously re-compiles and runs the lite-server. Both the compiler and the server watch for file changes. At this point you should be able to view the App at localhost:3000 in your browser.

you can shut the server down manually with Ctrl-C.

Setting up the API

The API is a Laravel 5.4 API with a requirement of running on PHP 7. It resides in the 'api' directory.

This project uses composer to install its dependencies. If you don't have composer installed, you can get it from here.

To set up the API, run the following commands from the project root folder:

pushd api
cp .env.example .env
php artisan key:generate
composer install

popd

That should set up your default environment file, and install project dependencies. The simplest way to get the API running is to run the following:

cd api
php artisan serve

This will start a very simple server listening on a default port (8000). You can specify the port with the --port=XXXX option. From there, you should be able to send a GET request as defined in the API documentation.


Known Bugs

No known bugs.


Support and Contact Details

Chat with us on Slack at codeforphilly.slack.com - '#rcos' channel


Technologies Used

  • TO-DO
  • Angular2
  • Bootstrap 4
  • npm
  • PHP 7
  • Laravel 5.4

License

This application is licensed under the MIT license