codebar website & event planner

A tool to help manage codebar.io members and events.

If you are considering making a PR, please take a look at the GitHub issues to see if there are any new feature requirements or bugs that you maybe able to help resolve.

Need help? We're on Slack!

Getting Started

The following steps walk through getting the application running. Before you start, please check out our contributing guidelines.

Clone the project
Enable GitHub Authentication
Install and set up the environment
Run the tests
Start the app

1. Clone the project

Navigate to your project's chosen parent directory, e.g. cd ~/Documents/codebar
Clone the project, e.g. git clone git@github.com:codebar/planner.git
Navigate into the project directory: cd planner

2. Enable GitHub Authentication

The application uses GitHub OAuth for user authentication. You'll need to create a new OAuth application on your GitHub account, then add the key and secret to your project's environment variables.

Create a new Github OAuth application

Visit https://github.com/settings/applications/new and fill out the form to create a new application. Use these field values:

Field	Value
Application name	Something memorable, like 'codebar planner'
Homepage URL	`http://localhost:3000`
Application description	Something memorable, like 'Local codebar app authentication'.
Authorization Callback URL	`http://localhost:3000/auth/github`

Add your application details to your environment variables

Mac/Linux:

Run touch .env to create a file named .env in the root of the application folder.
Open this .env file in a text editor, and add the GitHub key (Client ID) and secret (Client Secret) like so:

    GITHUB_KEY=YOUR_KEY
    GITHUB_SECRET=YOUR_SECRET

Windows:

Windows doesn't like creating a file named .env, so run the following from a command prompt in your project folder:

    echo GITHUB_KEY=YOUR_KEY >> .env
    echo GITHUB_SECRET=YOUR_SECRET >> .env

Note: If when starting the application with Docker you get the error UnicodeDecodeError: 'utf-8' codec can't decode byte 0xff in position 0: invalid start byte this may be because you created the .env-file using PowerShell. This can be solved by deleting that file and creating a new one using a bash shell (for example Git Bash).

3. Install and set up the environment

We recommend using Docker to install and run the application. However alternatively if you prefer, you can install directly to your system environment instead.

Install using Docker

Before you start, you will need to have Docker installed and running. You can download it from the Docker website.

The current Dockerfile and docker-compose were closely copied from the Docker guide.

Run bin/dbuild to build and setup the docker environment.
Run bin/drake to run all the tests and make sure everything works.

Note: If you are using Windows, you can run bin/dbuild using Git Bash.

4. Run the tests

Run bin/drake to run all the tests and make sure everything works. You can also use bin/drails and bin/dspec to run specific rails and rspec commands via docker.

Running single tests/test files

If you just want to run a single test file you can pass the path to the file, either using rspec or via the SPEC variable with rake:

bundle exec rspec <path to test>
bundle exec rake SPEC=<path to test>

This can also be used with specific line number (running only that one test), for example:

bundle exec rspec spec/features/admin/manage_workshop_attendances_spec.rb:42
bundle exec rake SPEC=spec/features/admin/manage_workshop_attendances_spec.rb:42

These also work with the corresponding bin/dspec and bin/drake commands.

Running JavaScript enabled feature tests with a visible browser

There are a small number of feature tests marked with js: true which use headless Chrome. These can be hard to work with without being able to see what is actually happening in the browser. To spin up a visible browser, pass CHROME_HEADLESS=false as part of the test command, for example:

CHROME_HEADLESS=false bundle exec rspec

Running JavaScript enabled tests with a visible browser currently doesn't work with Docker.

5. Start the app

Run bin/dstart to start the app.

This should run a process which starts a server in a Docker container on your computer. This process won't finish - you'll know the server is ready when it stops doing anything and displays a message like this:

Rails 4.2.11 application starting in development on http://0.0.0.0:3000

(Optional) Note that to be able to use the page as an admin, you must first give yourself admin privileges. Make sure you have started your app and signed up as an user on your locally running app. Then run a script bin/dadmin <your email>.

You can now view the app at http://localhost:3000

You can stop the server when you're finished by typing Ctrl + C.

Front-end framework

We use Foundation at version 5.5.3, you can find the documentation here: http://foundation.zurb.com/sites/docs/v/5.5.3/

Finding something to work on

You can pick one of the open issues, fix a bug, improve the interface, refactor the code or improve test coverage!

If there is something else that you would like to work on, open an issue first so we can discuss it. We are always open to new ideas and ways of improving planner!

Guidelines on contributing to planner

jobyh/planner