Final project for CS571 focused on financial statements and news sentiment of 60 companies from different sectors.
All development and commands should run from within the app folder.
Project proposal is the the Proposal folder (see ProjectProposalAnd5PDS.pdf).
Process book is in the ProcessBook folder (see ProcessBook.pdf).
Prerequisites:
If GitLFS is not installed, you will not be able to clone / pull the database file. If you install it after cloning, delete and re-clone the repo to get the database file.
To run the website after just downloading the repository, run the following scripts and then navigate to localhost:3000 in your preferred browser.
cd app # Node env is located in the app folder
npm i
npm run devIn the future, once dependencies are installed, you can run the run dev command instead to restart the website.
npm run devThe server and all related files are in the backend folder as described below:
server.js: The root server file. Servers the base HTML page and related static files.dataRoute.js: The router that serves SQL data from the database stored within thedatafolder.
The frontend is stored in the frontend folder. In the frontend we have the following folder structure:
public: Contains all statically served files.htmlandcssstore their respective files, whiledistis the folder containing the built JS, which also gets statically served.src: This is the folder where JS gets developed.index.jsis the root file that webpack builds from, and all other files go through the root.
To prevent styling mismatches, there is also a .prettierrc file that enforces specific formatting choices. It is encouraged to install the prettier extension if you are using VSCode to be able to use the enfoced auto-formatting.
The process book is a .md file that gets converted to html and then directly to pdf. The CSS file provided is a modified version of the default VSCode markdown CSS file, providing a clean design for the final product.
The process book is set up so each visual and each major section (data processing / server APIs) are under a ## heading. At the top of the file we are using a table of contents, and each heading is linked from there.
There is a screenshot folder screenshots where each subfolder contains images of the related visual that can be referenced from the process book file.
To build the process book .md file into a PDF file, run the following command:
npm run bookThe resulting PDF, ProcessBook.pdf, is what will be submitted for grading.