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 using docker

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

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

Run bin/dup to build and create the docker container. This will also set up the Rails application within the container and start the container. You will only have to run this command once. After initial setup, use bin/dstart to start an existing container - using bin/dup will recreate an existing container and reset the database.

4. Start the app

Run bin/dserver to start the Rails server.

*If you have previously stopped the container, you will have to first start the container using bin/dstart.

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://localhost: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 the 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.

5. Run the tests

Run bin/drspec to run all the tests.

This command passes any additional arguments into rspec in the docker container, so you can run individual tests with bin/drspec PATH_TO_TEST and run a single test case in a file with bin/drspec PATH_TO_TEST:LINE_NUMBER

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.

Available Docker commands

bin/dup: docker-compose up --build -d --wait && rake db:drop db:create db:migrate db:seed db:test:prepare. Rebuilds and boots up a new container, and then initialize the Rails database.
bin/dstart: docker-compose start. Starts the existing container.
bin/dserver: docker-compose exec web make serve. Runs the Rails server. Use this instead of bin/drails server to make it bind to the correct IP addresses to allow the server to be viewable outside the container.
drails: docker-compose exec web rails $@. Runs rails within the container.
drspec: docker-compose exec web rspec $@. Runs rspec within the container.
drake: docker-compose exec web rake $@. Runs rake inside the container.
dexec: docker-compose exec web bash. Runs a bash shell inside the container.
dadmin: Gives the the last user (or the one with a given email) the admin role
bin/dstop: docker-compose stop. Stops container but does not remove it
bin/ddown: docker-compose down. Stops and destroy a container.

Front-end framework

We use Bootstrap 5, you can find the documentation here: https://getbootstrap.com/docs/5.2/getting-started/introduction/

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

codebar/planner