Merge pull request #8 from alexjohn7516/develop

Develop => Production

README.md

@@ -1 +1,11 @@
 # Reddit Data Visualization
+
+# How I am working on this project
+My goal is to build a data heatmap using subreddit data from the Reddit REST API. The heatmap will show the activity of each subreddit based on time. You will be able to search any subreddit of your liking.
+
+* The use of a [Software Development Lifecycle](./SDLC.md) is probably unnessary for this small project but it is a good technique to learn.
+* I built the designs, UI/UX, and workflow of the app using Figma and github: [Project Designs PDF]().
+* I used 2 long lasting branches and a variety short lived (feature) branches that merge into the Development branch, and the development branch is merged into the production branch. I approahed this project with this workflow to simulate a professional workflow with a team.
+* Every PR is simulated with a [Template](.github/pull_request_template.md) to encorporate clear communication with every merge.
+* The Reddit API is open to the public as long as you have an authorization key, and I was interested in what data lies within it.
+* The project is build with Next.JS, TypeScript, Express, Node.js. I used Next.js because I was familiar with React and learned good things about it. I wanted to learn it and see how it works in comparison with React.

SDLC.md

@@ -0,0 +1,25 @@
+# Requirement Analysis
+I am wanting to build an application that shows activity of subreddits based on time of day. I have ideas for additional features but this is my main goal. I will be interactiving with the Reddit RESTFUL API to gather data from any and all subreddits NSFW included. The system I am going to use involves HTML, CSS, JavaScript/TypeScript, React, Next, Express, Node.js, Azure.
+
+# Planning
+I want to build this project in 2 weeks time. The current Date is **_September 20th 2022_** the deadline will be **_Octover 4th 2022_**. If I am able to get this done before that I will be happy with it.
+
+The project will follow specific formating and linting guidelines to keep everything pretty. The files can be found in the .eslintrc.json and the .prettierrc files.
+
+# Architectural Design
+All components written in code will run through tests before pushed to the develop branch. Unit testing code is important to keep foul bugs out of play. Most of the site will be static but the main component will be pulling data from a third party API.
+
+### For this project I require the following...
+1. Designs and a Project Board for ToDo Items about the projects. I will use Figma Design board to create the UI and part of the UX. This will also include the Fonts, Styling, Colors, and mobile font sizing and structure.
+2. Issue Request For enhancements through the project board in the main repository. This will show me my TODO's, Working on, and closed items. Each main feature issue will have its own branch. Touch up and bugs will have their own branches. I am styling this this way because I am the only developer. The branching workflow will be using will have 2 long lasting branches. Main(production) and the Development(develop) branch. I will use shortlived branches to encorporate the main features, bugs, hotfixes, and touchups that merge into the development branch. I am simulating a professional work flow with a team.
+3. Create all main static features.
+4. Learn the Reddit API to get data. This might require me using express to pull in data server side to format what I need for the frontend. It might be a costly compute I am unsure at the moment.
+5. Implement the heatmap. The colors will change from a scale of red to green. red being at the bottom of the barrel and green being at the top of the barrel. Meaning the more activity of the subreddit the greener it gets. The less, the redder. Note: all subreddits have different amounts of traffic will there be a scale thats computed for each one? A maximum that is computed? Or will there be a filter to see how much activity in thousands that is represented? **Final: There will be a heat map that calculates the maximum traffic through out the day and the color will scale with that and the heatmap will show the amount in thousands whe you hover over a tile.**
+[Link to Designs and Task Board]()
+
+# Software Development
+
+# Testing
+
+# Deployment
+Github actions for CI/CD when the development is pushed to production

deleteme

@@ -0,0 +1 @@
+test file for pr template test