Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 3.62 KB

README.md

File metadata and controls

67 lines (47 loc) · 3.62 KB
Raw

Our sweet logo designed by Dominic Flask

StartupWichita.com

Ruby on Rails application for communities, their news, events, and resources; built for what Wichita, Kansas needed in their tech and startup scene.

Well, hello there. My name is Kenton Hansen. You might remember me from such works as "Startup Weekend Wichita" or "The Labor Party." Today, however, I'm here to talk about this web application started at a Hackathon in March 2014 with devICT.

The projects beta was completed and launched about three months later at startupwichita.com, and we as a community have been contributing to its development since then.

Find an Issue?

Please report any problems you might encounter by creating an Issue.

Requirements

  • ruby version 2.2.0
  • ImageMagick or GraphicsMagick command-line tool (used in minimagick gem)
  • bundler

Installation and Setup

Clone the repo and cd into the directory.

git clone https://github.com/StartupWichita/startupwichita.com.git
cd startupwichita.com

Then run bundle install Run the mirgations rake db:migrate Start server rails s

We use sqlite3 as database. Data seeding is also included in the migrations.

Alternatively, use docker-compose

Assuming you have docker and docker-compose installed on your system.

docker-compose up - builds the image, runs migrations and seeding, and starts server. Should be accessible at port 3000 once running.

To run commands in the context of the app, use: docker-compose run app <your cmd>. For example: docker-compose run app bundle exec rake db:migrate.

We would love for you to use this app for your community or to contribute:

Pull requests generally

  • The smaller the proposed change, the better. If you’d like to propose two unrelated changes, submit two pull requests.
  • The more information, the better. Make judicious use of the pull request body. Describe what changes were made, why you made them, and what impact they will have for users.
  • Pull requests are easy and fun. If this is your first pull request, it may help to understand GitHub Flow.
  • If you’re submitting a code contribution, be sure to read the code contributions section below.

Submitting a pull request via github.com

  1. Navigate to the file within StartupWichita/startupwichita.com that you’d like to edit.
  2. Click the pencil icon in the top right corner to edit the file
  3. Make your proposed changes
  4. Click “Propose file change”
  5. Click “Create pull request”
  6. Add a descriptive title and detailed description for your proposed change. The more information the better.
  7. Click “Create pull request”

That’s it! You’ll be automatically subscribed to receive updates as others review your proposed change and provide feedback.

Submitting a pull request via Git command line

  1. Fork the project by clicking “Fork” in the top right corner of StartupWichita/startupwichita.com.
  2. Clone the repository locally git clone https://github.com/StartupWichita/startupwichita.com.git
  3. Create a new, descriptively named branch to contain your change
    git checkout -b name_of_your_branch
  4. Push the branch up git push origin name_of_your_branch
  5. Create a pull request by visiting https://github.com/your-username/startupwichita.com and following the instructions at the top of the screen.