Skip to content
A club and event directory for the New York Interschool consortium, built with Ruby on Rails.
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.
app
bin
config
db
lib
log
public
storage
test
tmp
vendor
.gitignore
.ruby-version
Gemfile
Gemfile.lock
LICENSE
README.md
Rakefile
config.ru
package.json

README.md

Icarus Labs

Version Rails Ruby MIT License

The New York Interschool Club Directory is an open source project built to connect
students with clubs and events within the consortium.

Report a Bug


Getting Started

We recommend testing and developing using AWS Cloud9. The documentation below assumes you are working in that environment.

Step 1: Install the dependencies located in the project's Gemfile:

$ bundle install

Step 2: Start the MySQL server:

$ sudo service mysql start

Step 3: Enter the MySQL CLI (after you setup your user in Step 4, we recommend using those credentials to access the CLI):

$ mysql -u root -p

Step 4: Create a MySQL user (don't forget to change username and password):

mysql> CREATE USER 'username'@'localhost' IDENTIFIED BY 'password';

Step 5: Create a MySQL database:

mysql> CREATE DATABASE database_name;

Step 6: Link your user to your MySQL database (don't forget to change username and password to match your configuration in Step 4):

mysql> GRANT ALL PRIVILEGES ON *.* TO 'username'@'localhost' IDENTIFIED BY 'password';

Step 7: Refresh your MySQL privileges:

mysql> FLUSH PRIVILEGES;

Step 7: Configure the application for your MySQL database. Edit the database.yml file located in the config directory (don't forget to change MYSQL_DATABASE, MYSQL_USERNAME, MYSQL_PASSWORD to match your configuration in Steps 4 and 5):

20   development:
21     <<: *default
22     database: MYSQL_DATABASE
23     host: <%= ENV['IP'] %>
24     username: MYSQL_USERNAME
25     password: MYSQL_PASSWORD

Step 8: Migrate the database:

$ rake db:migrate

Step 9: Start the Rails application:

$ rails s -b $IP -p $PORT

NOTE: Whenever you start the application, make sure your MySQL database is running.

Helpful Commands:

View Routes:

$ rake routes

Learn more about routes.

Create a new Controller:

$ rails g controller User

Learn more about generating a controller.

Create a new Model:

$ rails g model Post title:string body:text

Learn more about generating a model.

Create a new migration:

$ rails g migration add_user_id_to_comments user_id:reference

Learn more about running a migration.

Versions

Current Version: Beta v0.1.0 (pre-release)

Planned Releases:

Credits

Copyright (c) New York Interschool, 2019. Created by Sebastian Rodriguez using Ruby on Rails, maintained by various contributors. Released under the MIT license.

Contributors

Have an idea for a new feature? Want to help maintain the software? Contact your school's Computer Science Department Chair or Dean of Students to learn how to contribute. We encourage and depend on student and faculty participation. You must be affiliated the New York Interschool to contribute.

You can’t perform that action at this time.