A flexible, open-source web app to help publicise, manage, and monitor the projects for the MHS Byte Club. This project allows members to sign in to meetings for more reliable attendence. Members can post links and descriptions of their current projects. The public-facing parts of this project help to show off members projects.
Finally, this project is intended to be a work-in-progress and a coordinated effort of Byte Club members. Any member can make PRs and add features as their skills and time permits. Contribute and make something great with Byte Club!
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Please Note: This project uses google_oauth2 authentication which will not work in your local environment.
This project requires the use of:
- Ruby (~2.6.0)
- Rails (~5.2)
- Postgresql
A step by step series of examples that tell you how to get a development env running
- Begin by forking and cloning this repository to your local machine.
# clone the repo to your local machine using the gits
git clone [your forked repo]
# cd into your newly-created directory
cd byteclub
- Start your postgresql server with the following command(s)
sudo service postgresql start
Postgresql runs a database server that helps to manage and store the data for your development environment. It is required so that data can persist and be "remembered" when developing, building, and testing new features.
- Setup a new postgres database with the following commands:
# Connect to the postgresql service
psql
# create a postgresql database with the name specified in congif/database.yml
ubuntu=# CREATE DATABASE "bc_dev";
# List the databases to be sure it was created correctly
ubuntu=# \list
# Should show something like this below
List of databases
Name | Owner | Encoding | Collate | Ctype | Access privileges
-----------+----------+-----------+---------+-------+-----------------------
bc_dev | ubuntu | SQL_ASCII | C | C |
- Install all of the Ruby Gems needed by running bundle install
bundle install
- Migrate your database so it's all setup and ready to accept the data Rails will send to it.
# this is the safest way to call this and make sure that it works...
bundle exec rake db:migrate
- Run your dev server and get developing
rails server -p [port of your choice]
# or if you're running from Cloud9 IDE, uses Cloud9 defaults to serve
rails server -b $IP -p $PORT
- Navigate to localhost or your Cloud9 dev location and make sure you see the Byte Club homepage there!
If you run into issues with your Ruby or Bundler versions, follow the prompts in the command line.
- Be sure you've installed and are using the correct Ruby versions
rvm install ruby-2.6.1
- Also, check that you've got the most updated version of Bundler
bundle update --bundler
# or...
gem install bundler:2.0.1
Add additional notes about how to deploy this on a live system
- Ruby on Rails - The web framework used
- Bootstrap gem - Styling
- google_oauth2 - Google Omniauth strategy
- Cloud9 IDE - Cloud-based IDE
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
- Matt Farmer - Initial work - Farmer & Dell
This project is licensed under the MIT License - see the LICENSE.md file for details
- MHS Byte Club members, who are awesome and willing to work hard and try something new