Skip to content

Latest commit

 

History

History
55 lines (36 loc) · 3.64 KB

README.md

File metadata and controls

55 lines (36 loc) · 3.64 KB

Historical-media

License: MIT

Description

The purpose of this application was to create a social media that uses historical events on the current day. Think of it like Twitter but with history! So when you load into the site, you will see a list of events that occur on that day and some posts that other users have made about an event that occured. We built this project to have a fun and unique take on a social media site that users can view different and interesting historical events each day, can view others' posts that may give them more insight and knowledge on the event, and can click on a event to create a post about said event themselves. This project was made with express, node.js, sequelize, handlebars, and mysql as well as mysql2 and a scheduler in the form of node-cron. The application is also being deployed on Heroku.

Table of Contents

If your README is long, add a table of contents to make it easy for users to find what they need.

Installation

To install this application, you need clone the repository. To clone the repository, you go to the green button on the repository that says "< > Code". Then you can choose to copy either the https url or the ssh url if you have a ssh key. After you copy the link, then you go to your terminal on your computer and in the terminal, you change the current directory to the directory you want to place the cloned repository in and then you type "git clone" and paste the url. Finally, you hit enter and the repository will be on your machine and you can open the index.html in your browser by right clicking the html in the directory and choosing which browser to open it in. This application is also deployed on Heroku so you can view it on heroku using the deployed page. The deployed Heroku link is https://calm-castle-61617.herokuapp.com/.

Usage

When you load into the website, you will see a small list of historical events that occured on the current day and a feed of people who made a post on one of the events. You can go to the events page to view more events. You can click on one of the events on the homepage or events page, which will let you to create a post about the event, allowing you to say something about the post. However, you must sign up and login with your own email and password in order to create a post of the events. To sign up or login, You can either click on the respective buttons to take you to their page. Attempting to create a post will also redirect to the sign up or login page if you have not logged in.

image

License

This application license is: MIT

Contribution

Credits

Questions

The GitHub used to host the files of this application is Smulchman. If you have any questions, please contact us on the GitHub. We will reach back to you as soon as possible