Git Product home page Git Product logo

giraffle's Introduction

Giraffle

Quick Raffle Generator and Drawing App

www.giraffle.me

website

Running Application

Initial setup

This project uses MongoDB.

The follow mongodb setup commands only need to be performed on initial setup of MongoDB on your system. The following are instructions for setup for a Mac.

# install mongodb using brew
brew install mongodb

# create the folder where mongo will store its data
mkdir -p /usr/local/var/mongodb

# ensure this data directory has the correct permissions
sudo chown -R `id -un` /usr/local/var/mongodb

# mongodb stores its configuration file under /usr/local/etc/mongod.conf
# check this file to confirm the dbPath has been set correctly, or to get this value in the future
cat /usr/local/etc/mongod.conf

# should give output similar to this:
systemLog:
  destination: file
  path: /usr/local/var/log/mongodb/mongo.log
  logAppend: true
storage:
  dbPath: /usr/local/var/mongodb
net:
  bindIp: 127.0.0.1

This project also uses Yarn as a dependency manager.

To install yarn on your (Mac) system, run the following command:

brew install yarn

Run application

# start local mongodb instance in a shell window
mongod -dbpath /usr/local/var/mongodb

# in a different shell window navigate to the root of this repository and run the following command:
yarn install

# run the application
npm start

# or to run watch on the file system:
npm run watch

After running the above commands you should see the application successfully run and output the localhost url and port where you can view the application running in your browser.

Deployed Application

This application is deployed using Heroku and MongoDB Atlas.

Future Features

"...a work is never truly completed [...] but abandoned..." Paul Valéry

Nice-to-have features:

  • shortened links for easy raffle link sharing
  • option to text short link to user to view results after entering raffle
  • improved authorization controls
  • better handling of input validation for users
  • add testing

giraffle's People

Contributors

dependabot[bot] avatar sharkysharks 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.