Table of Contents
- Getting started
- Code Style
This project is a platform for session photographers written in Ruby. You can use this platform to manage clients, book sessions, publish blog posts, maintain portfolio, and provide deliverables to clients through galleries.
To install, fork the repo and execute:
git clone [YOUR REPO URL HERE] cd photog-app bundle
Then, create the
.env file and enable user signup.
Create the database and run the migrations (note: you must have
postgresql installed on your local machine.)
rails db:create rails db:migrate
To signup, fire up the server and navigate to
http://localhost:3000/sign_up (the link is not displayed anywhere, so you'll need to manually enter the URL any time you need to signup a user). You can disable signup through the
.env file in your development environment or through the
ALLOW_SIGNUP environment variable in your production environment.
Usage instructions will be published as features are rolled out.
# Run rubocop for the entire project bundle exec rubocop # Run rubocop for a specific file bundle exec rubocop foo/bar.rb
Comment any code contributions according to the existing conventions within the project. Reference the examples listed below:
Example top-level comment:
## # = ClassNameGoesHere # Author:: Richard Davis (+/- individual contributors) # Copyright:: Copyright 2017 Mushaka Solutions # License:: GNU Public License 3 # # This is a class that is something and does something.
Example method comment:
## # This is a method that does something
Documentation can be generated using custom rake task. For more information on RDoc, go here.
# Run custom rake task to regenerate RDoc documentation rake rdoc
Integration tests should be written for all classes and methods. The test suite
can be run manually
bundle exec rake test.