Skip to content

Latest commit

 

History

History
63 lines (43 loc) · 2.68 KB

README.md

File metadata and controls

63 lines (43 loc) · 2.68 KB

Schoodle - Read Me

Schoodle is a useful scheduling and polling app which allows the user to create a poll on different times of the meeting. It is easily sharable with anyone who knows the link, and can be voted to decide when they want to meet up!

Getting Started

  1. Create the .env by using .env.example as a reference: cp .env.example .env
  2. Update the .env file with your correct local information
  • DB_USER=postgres or your database username
  • DB_PASS= or your database password
  • DB_NAME=midterm or your database name
  • DB_PORT=5432
  • DB_HOST=localhost
  1. Install dependencies: npm i
  2. Fix to binaries for sass: npm rebuild node-sass
  3. Reset database: npm run db:reset
  • Check the db folder to see what gets created and seeded in the SDB
  1. Run the server: npm run local
  • Note: nodemon is used, so you should not have to restart your server
  1. Visit http://localhost:8080/

App Flow

Welcome to Schoodle!

Give your meeting a title, a description, register your name and email, and pick your date & time options for the poll

Screen Shot 2021-06-21 at 2 08 09 AM

After created your meeting poll, you can choose to vote by entering your name and email. Or you can choose to vote later and send this poll to others by copying the unique url

Screen Shot 2021-06-21 at 2 09 03 AM

The poll result is calculated in real-time

Screen Shot 2021-06-21 at 2 11 47 AM

APIs and Tech Stack

This project used JavaScript, CSS for the Frontend and Node.js for the Backend. PostgreSQL is used for the database, and deployed on Heroku

Stack: JavaScript (jQuery, AJAX), Node.js, Express, CSS, Bootstrap, PostgreSQL, Heroku

Authors

Warnings & Tips

  • Use the npm run db:reset command each time there is a change to the database schema or seeds.
    • It runs through each of the files, in order, and executes them against the database.
    • Note: you will lose all newly created (test) data each time this is run, since the schema files will tend to DROP the tables and recreate them.

Dependencies

  • Node 10.x or above
  • NPM 5.x or above
  • PG 6.x

License

This project is licensed under the LHL License