readroster

Created by Alisa Vorotyntseva

Readroster is an online library book tracker built using PostgreSQL, Express.js, React & JavaScript, Tailwind CSS, Node.JS, Twilio API, and Mailgun API. The web application allows users to add/track their checked-out library books and customize alerts to remind them of any approaching due dates.

Registration Page

Login Page

Add A Book / Set Alerts

new.book.mov

Edit Alerts / Delete Book

edit.delete.mov

iCal Event

SMS Alert

Email Alert

How It's Made:

Tech used: PostgreSQL, Express.js, React, Node.js, JavaScript, Tailwind CSS, Twilio API, Mailgun API, Cloudinary API

Setup:

• On your terminal, clone the repo via [email protected]:vorotyna/read-roster.git
• On your preferred code editor, open the root project folder and navigate to the server folder
  • Duplicate the .env.example file located in read-roster/server, then remove .example from the filename
    • In this newly-created .env file, provide the variables with relevant values (will have to register for Twilio and Mailgun)
    • Save your changes
• On your terminal, enter psql
  • Then follow instructions found in read-roster/server/db/instructions.md
• On your terminal, navigate to read-roster/server
  • Then npm i
  • Then npm start
• On a separate terminal, navigate to read-roster/client
  • Then npm i
  • Then npm start
• Keep the 2 terminals up and running
• On your browser, navigate to http://localhost:3000 and start exploring the app!