Giter VIP home page Giter VIP logo

secret-santa's Introduction

Secret Draws App


This is the frontend for the Santa Draws app backend repo here. This was a group project that was part of the Manchester Codes bootcamp course. You can view the presentation explaining this app here.


Decsription

An app for all the family! Christmas present budget getting out of control? Sick of pulling names out of a hat and having to redraw when you pick yourself? Try our app!

The app will allow you to:

  • Sign up,
  • Log in,
  • Assign a gift exchange date and budget,
  • Countdown with you to Christmas,
  • Generate a group invite link to the draw,
  • Automatically assign a name to you, excluding yourself,
  • Allow you to add your likes and dislikes, or a wishlist of your own,
  • Let other gift-givers send you tips and links to present ideas for the person you have drawn, anonymously!

Santa draws login pageSanta draws create event pageSanta draws display event page

Installation Instructions

  1. Run git clone https://github.com/SuzBarnes/secret-santa into the console.
  2. cd into the new directory
  3. Run npm install

Useful Commands:

How to... Command Further Details
Start the app npm start it will load on localhost:3000
Test npm test the tests will take place and any errors will be displayed in your console
Format npx prettier --write . Prettier is the ESLint tool used to help with formatting of the App

How to use:

  • First you must register for an account and then login.
  • Then you can create your own secret Santa event (you are the admin for this event) and send the invitation to everyone, or you can join an event someone else has already created.
  • You can change your account details and update your likes and dislikes so the person who gets drawn your name has ideas of what to buy you.
  • Once everyone had joined your event, you (the admin of the event) can click the draw names button which will assign everyone a name.
  • You can view your events in the my events page and add suggestions anonymously for anyone else in the event.

Technologies

  • Created by bootstrapping the Create React App.
  • Uses React, JavaScript, JSX and SASS.

Further time

In the future we would like to include more tests for better coverage and to refactor the code to be DRY. Additional features we would like to add include:

  • Change the event invite code to be either a string of words or a larger number with a expiration time on it.
  • Add postal address field for worldwide Secret Draws use,
  • Send a notification to users when the names have been drawn,
  • Expand it for different events by adding other themes to app using useContext hook. We would also like to deploy the app.

Authors

Social Alex Bradley Suzannah Barnes Lisa Heffernan
GitHub @AlexPBradley @SuzBarnes @LCHeffernan
LinkedIn Alex Bradley Suzannah Barnes Lisa Heffernan
Twitter @Iisaheffernan

secret-santa's People

Contributors

suzbarnes avatar lcheffernan avatar alexpbradley avatar

Watchers

 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.