Giter VIP home page Giter VIP logo

partyplannersite's Introduction

PartyPlannerSite

Sinatra powered site for planning events and inviting other users. This is the second Learn.co project for flatiron boot camp.

Install

Project is installed via Bundler Project is coded for development mode

  1. clone project
  2. run bundle install
  3. create party.env from party.env.example
    • see ENV config section for more info
  4. source party.env
  5. Create database with rake db:create:all
  6. Set up with rake db:migrate and rake db:seed
  7. Run shotgun to start webserver.

ENV configs

  • Required:
    • PARTY_SENDGRID_API_KEY - Send grid api key
    • PARTY_SENDGRID_EMAIL - Send grid TO email address
    • PARTY_HMAC_URl_KEY - used for hmac url key, generate via securerandom, must be 64 bits
    • PARTY_SESSION_KEY - used for session secret, generate via securerandom, must be 64 bits
  • Debug (OPTIONAL):
    • PARTY_DISABLE_DNS - set to 'YES' to disable DNS checks for user email.
    • PARTY_DISABLE_EMAIL - set to 'YES' for email request to silently be ignored.

Send Grid

Project uses Send Grid to manage emails for user account creation and passwordless logins. The api only need enough access to send email. Full access is not needed or recommended.

Admin User

For security reasons, it is not possible to create an admin user via the website. Users must be elevated to someone with DB access. Admin have ability to add/modify/delete Venues and Themes.

Routes

Party planner uses before routes for authorization checks. Finer grain control permission are handles in controllers.

  • '/pre_auth/*' - Non-Logged in users only
  • '/post_auth/*' - Logged in users only
  • '/hmac/*' - Must have valid hmac/non-expired to reach.
  • '/admin/*' - Logged in admin users only

Thanks to

partyplannersite's People

Contributors

anthonyntilelli avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.